apidoc-light

Fork of apiDoc with a way-lighter bundle optimized for programmatic usage.

it's used in apidoc-markdown.

Warning: This is only meant to be used with programmatic usage. Documentation generation will not work!

Features:

• As minimal as possible code changes to easily keep in sync with new future apidoc updates
• Removed unnecessary CLI
• Removed unnecessary documentation templates
• Removed unnecessary dependencies
  • bootstrap
  • commander
  • diff-match-patch
  • expose-loader
  • handlebars
  • jquery
  • nodemon
  • path-to-regexp
  • prismjs
  • url-parse
  • webpack
  • webpack-cli
  • style-loader
• Removed console log on uncaughtException
• Removed file Writer
• Outputs objects instead of JSON strings
• Bubble up the errors to the lib consumer
• dryRun options set to true by default
• Annoying warn: Provided "src" option is not an array. Converting it to array. now logged to debug log mode only
• Minimal typings integrated directly
• Removed tests relevant to documentation generation

Usage

pnpm install apidoc-light

import { createDoc } from 'apidoc-light'

const doc: Doc = createDoc({ src: input })

// Output
type Doc = {
  project: Record<string, any> // apiDoc project object (`apidoc.json`)
  data: Array<Record<string, any>>: // apiDoc documentation object (`api_data.json` file content)
}

License

MIT License

Copyright (c) 2013-2021 inveris OHG
Copyright (c) 2021 rigwild <[email protected]> (https://github.com/rigwild)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

apiDoc

apiDoc creates a documentation from API descriptions in your source code.

Documentation: apidocjs.com

Live DEMO

Installation

$ npm install -g apidoc

Usage

Add some apidoc comments anywhere in your source code:

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

Now generate the documentation from src/ into doc/.

$ apidoc -i src/ -o doc/

This repository contains and example folder from which you can generate a very complete documentation on an example api endpoint. It also contains best practice hints (in the footer.md file).

$ git clone https://github.com/apidoc/apidoc && cd apidoc
$ npm install --prod
$ ./bin/apidoc -i example -o /tmp/doc
$ $BROWSER /tmp/doc

Programmatic usage

You can generate the documentation programmatically:

import path from 'path'
import { createDoc } from 'apidoc'

const doc = createDoc({
  src: path.resolve(__dirname, 'src'),
  dest: path.resolve(__dirname, 'doc'), // can be omitted if dryRun is true
  // if you don't want to generate the output files:
  dryRun: true,
  // if you don't want to see any log output:
  silent: true,
})

if (typeof doc !== 'boolean') {
  // Documentation was generated!
  console.log(doc.data) // the parsed api documentation object
  console.log(doc.project) // the project information
}

Install type definitions (see @types/apidoc):

$ npm install -D @types/apidoc

Docker image

You can use apidoc in Docker like this:

# first build the image after cloning this repository
docker build -t apidoc/apidoc .
# run it
docker run --rm -v $(pwd):/home/node/apidoc apidoc/apidoc -o outputdir -i inputdir

Supported programming languages

• C#, Go, Dart, Java, JavaScript, PHP, Scala (all DocStyle capable languages):

  /**
    * This is a comment.
    */

• Clojure:

  ;;;;
  ;; This is a comment.
  ;;;;

• CoffeeScript:

  ###
  This is a comment.
  ###

• Elixir:

  #{
  # This is a comment.
  #}

• Erlang:

  %{
  % This is a comment.
  %}

• Perl

  #**
  # This is a comment.
  #*

  =pod
  This is a comment.
  =cut

• Python

  """
  This is a comment.
  """

• Ruby

  =begin
  This is a comment.
  =end

Plugins (extend apiDoc)

apiDoc will auto include installed plugins.

• apidoc-plugin-schema Generates and inject apidoc elements from api schemas. npm install apidoc-plugin-schema

For details and an example on how to implement your own plugin, please view apidoc-plugin-test.

Support

Please create a new issue if you have a suggestion/question or if you found a problem/bug.

Contributing

apiDoc is a collaborative project. Pull requests are welcome. Please see the CONTRIBUTING file.

Build tools

• flask-apidoc pip install flask-apidoc
• grunt-apidoc npm install grunt-apidoc.
• gapidoc (gulp) npm install gapidoc.
• webpack-apidoc npm install --save-dev webpack-apidoc.

Integration

• Eclipse Java apiDoc editor templates
• Eclipse plugin
• Microsoft WebAPI
• Sublime Text plugin

Converter

• apidoc-swagger
• apidoc-swagger-3
• gulp-apidoc-swagger
• Docmaster
• apidoc-markdown