Skip to content
apidoc and swagger are two nice projects which are focusing on documentation of APIs. This project is a middle tier which tries to bring them together in a sense that it uses apidoc to convert inline documentation to json schema and later convert it to swagger json schmea.
Branch: master
Clone or download
Latest commit b73be12 Sep 9, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Add config and ignore yarn.lock Sep 9, 2018
bin
lib Fix #14 - makes access to Parameters attribute in fields non-breaking… Mar 4, 2016
test/simple Adding and testing first test Sep 9, 2018
.gitignore Adding and testing first test Sep 9, 2018
.npmignore Add config and ignore yarn.lock Sep 9, 2018
LICENSE Version 0.0.0 Apr 1, 2015
README.md Update README.md Sep 9, 2018
package.json Adding and testing first test Sep 9, 2018
yarn.lock Adding and testing first test Sep 9, 2018

README.md

apidoc-swagger

Build status: CircleCI

apidoc and swagger are two nice projects which are focusing on documentation of APIs. This project is a middle tier which tries to bring them together in a sense that:

It uses apidoc to convert inline documentation comments into json schema and later convert it to swagger json schema.

Uses the apidoc-core library.

How It Works

By putting in line comments in the source code like this in javascript, you will get swagger.json file which can be served to swagger-ui to generate html overview of documentation.

/api/foo.js:

/**
 * @api {get} /user/id Request User information
 * @apiName GetUser
 * @apiGroup User
 *
 * @apiParam {Number} id Users unique ID.
 *
 * @apiSuccess {String} firstname Firstname of the User.
 * @apiSuccess {String} lastname  Lastname of the User.
 */

Installation

npm install apidoc-swagger -g

Current version unlocks most of the basic capabilities of both projects and improvement is in progress.

Example

apidoc-swagger -i example/ -o doc/

Have a look at apidoc for full functionality overview and capabilities of apidoc.

To read more about how swagger works refer to swagger-ui and swagger-spec for details of swagger.json.

Gulp Module

gulp-apidoc-swagger npm install gulp-apidoc-swagger.

You can’t perform that action at this time.