Giter VIP home page Giter VIP logo

ex_slack_api_docs's Introduction

Mix Task Slack API Docs

A mix task for generating JSON API docs based on the Slack API. The format is similar to the deprecated repository: https://github.com/slackhq/slack-api-docs.

Installation

You can either add it as a dependency in your mix.exs, or install it globally as an archive task.

To add it to a mix project, just add a line like this in your deps function in mix.exs:

def deps do
  [
    {:slack_api_docs, "~> 0.1.2", only: [:dev], runtime: false}
  ]
end
mix do deps.get, deps.compile

Usage

mix slack_api_docs.gen.json lib/slack/web/docs

If you want to validate the generated output against remote, you can simply run:

mix slack_api_docs.verify lib/slack/web/docs

Command line options

  • --concurrency 75 - default: 50, the amount of requests running in parallel
  • --quiet - suppress all informational messages.

ex_slack_api_docs's People

Contributors

inooid avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.