Giter VIP home page Giter VIP logo

apidocbot's Introduction

Apidocbot

A simple bot to generate api docs

Installation

Add this line to your application's Gemfile:

gem 'apidocbot', :git => '[email protected]:yanguango/apidocbot.git'

And then execute:

$ bundle

Or install it yourself as:

$ gem install apidocbot

Usage

###1. generate apidocbot templates rails generate apidocbot

###2. write your api doc yaml files Example:

	'GET /users/:id':
	  description: 'Get specified users'
	  params:
	  example_request: 'http://example.com/api/users/1'
	  example_response: |
	    {
	      "id":1,
	      "name":"samyang",
	      "birthday":"1986-09-22",
	      "gender":"male",
	      "created_at":"2012-03-23 14:06:25"
	    }

###3. run rake task to generate your api doc rake apidocbot the result api doc will be in the output.html

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

apidocbot's People

Contributors

yanguango avatar

Watchers

 avatar James Cloos 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.