apidoc-light
Version:
RESTful web API Documentation Generator
284 lines (210 loc) • 7.6 kB
Markdown
# apidoc-light
Fork of apiDoc with a way-lighter bundle optimized for programmatic usage.
it's used in [apidoc-markdown](https://github.com/rigwild/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
```sh
pnpm install apidoc-light
```
```ts
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 <me@rigwild.dev> (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.
[](http://badge.fury.io/js/apidoc)
[](https://gitter.im/apidoc/talk?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
### Documentation: [apidocjs.com](http://apidocjs.com)
### [Live DEMO](http://apidocjs.com/example/)
## Installation
```bash
$ npm install -g apidoc
```
## Usage
Add some apidoc comments anywhere in your source code:
```java
/**
* @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/`.
```bash
$ 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).
```bash
$ 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:
```ts
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](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/apidoc/index.d.ts)):
```bash
$ npm install -D @types/apidoc
```
## Docker image
You can use apidoc in Docker like this:
~~~bash
# 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):
```javascript
/**
* This is a comment.
*/
```
* **Clojure**:
```clojure
;;;;
;; This is a comment.
;;;;
```
* **CoffeeScript**:
```coffeescript
###
This is a comment.
###
```
* **Elixir**:
```elixir
#{
# This is a comment.
#}
```
* **Erlang**:
```erlang
%{
% This is a comment.
%}
```
* **Perl**
```perl
#**
# This is a comment.
#*
```
```perl
=pod
This is a comment.
=cut
```
* **Python**
```python
"""
This is a comment.
"""
```
* **Ruby**
```ruby
=begin
This is a comment.
=end
```
## Plugins (extend apiDoc)
apiDoc will auto include installed plugins.
* [apidoc-plugin-schema](https://github.com/willfarrell/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](https://github.com/apidoc/apidoc-plugin-test).
## Support
Please [create a new issue](https://github.com/apidoc/apidoc/issues/new/choose) 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](https://github.com/apidoc/apidoc/blob/master/CONTRIBUTING.md) file.
## Build tools
* [flask-apidoc](https://pypi.python.org/pypi/flask-apidoc/) `pip install flask-apidoc`
* [grunt-apidoc](https://github.com/apidoc/grunt-apidoc) `npm install grunt-apidoc`.
* [gapidoc (gulp)](https://github.com/techgaun/gulp-apidoc) `npm install gapidoc`.
* [webpack-apidoc](https://github.com/c0b41/webpack-apidoc) `npm install --save-dev webpack-apidoc`.
## Integration
* [Eclipse Java apiDoc editor templates](https://github.com/skhani/eclipse_java_apiDoc_templates)
* [Eclipse plugin](https://github.com/DWand/eclipse_pdt_apiDoc_editor_templates)
* [Microsoft WebAPI](https://github.com/chehabz/grunt-edge-apidoc-webapi-generator)
* [Sublime Text plugin](https://github.com/DWand/ST3_apiDocAutocompletion)
## Converter
* [apidoc-swagger](https://github.com/fsbahman/apidoc-swagger)
* [apidoc-swagger-3](https://github.com/amanoooo/apidoc-swagger-3)
* [gulp-apidoc-swagger](https://github.com/fsbahman/gulp-apidoc-swagger)
* [Docmaster](https://github.com/bonzzy/docmaster)
* [apidoc-markdown](https://github.com/rigwild/apidoc-markdown)