Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dapi-labs/outdoc
Auto generate openAPI document from unit test
https://github.com/dapi-labs/outdoc
api api-doc api-docs-generator api-documentation-tool api-generator openapi
Last synced: 4 days ago
JSON representation
Auto generate openAPI document from unit test
- Host: GitHub
- URL: https://github.com/dapi-labs/outdoc
- Owner: dapi-labs
- License: mit
- Created: 2022-08-06T10:14:36.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-11-10T12:45:39.000Z (about 2 years ago)
- Last Synced: 2025-01-01T11:07:09.430Z (about 1 month ago)
- Topics: api, api-doc, api-docs-generator, api-documentation-tool, api-generator, openapi
- Language: TypeScript
- Homepage:
- Size: 184 KB
- Stars: 4
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Outdoc
Auto generate OpenAPI document from local HTTP testing
[](https://www.npmjs.org/package/outdoc)
[![npm download][download-image]][download-url]
[download-image]: https://img.shields.io/npm/dm/outdoc.svg?style=flat-square
[download-url]: https://npmjs.org/package/outdoc
_colorful robot writing document by Stable Diffusion_
## Installation
```bash
$ npm install outdoc -D
```
## Usage
Add the following codes into your main file
```js
const { OutDoc } = require('outdoc')
if (process.env.NODE_ENV === "test") {
OutDoc.init()
}
```
Run the command
```bash
$ npx outdoc [test command] [options]
```
Usually it could be, for example:
```bash
$ npx outdoc npm test -t project-name
```
Adn it will generate an api.yaml in your root folder by defaults
## Options
```
-o, --output file path of the generated doc, format supports json and yaml, default: api.yaml
-t, --title title of the api document, default: API Document
-v, --version version of the api document, default: 1.0.0
-e, --email contact information
-f, --force run the script without adding OutDoc.init in the code
-h, --help display help for command
```
## Examples
Please check [examples](https://github.com/dapi-labs/outdoc/tree/main/examples) in here of how to use Outdoc with different frameworks
## Not adding extra codes
You might don't wanna add any extra codes in your project only for generating API document, then you can do:
First, Check if the **main** in your package.json pointing to your app entry file which export your nodejs server. If not, please add the attribute **outdoc** pointing to it. If you are writting a Typescript project, you need to add the following configuration.
```json
{
"outdoc": {
"main": "./src/app.ts"
}
}
```
Then run the command with the option **-f**
```bash
$ npx outdoc npm test -f
```
#### What is happending behind `-f`
By using the option `-f`, Outdoc will first check the **outdoc.main** in your package.json, if it not exist, Outdoc will use **main** in the package.json to find the app entry file.
Then Outdoc will copy the entry app file and insert codes into it, and use the new copied file as the entry app file, the concrete steps are:
1. Find your app entry file from package.json, for example the file is named as app.js
2. Copy app.js to a new temporary file named tmp_outdoc_file
3. Insert Outdoc.init into app.js and start running the program to generate the API doc
4. After the generation finished, copy back the content of tmp_outdoc_file to app.js and remove tmp_outdoc_file
## Notes
Outdoc can only understand tests who are sending and receiving real HTTP requests, for example using the [supertest](https://github.com/visionmedia/supertest) in your test cases.
Mocked HTTP request won't work with Ourdoc, like fastify.inject.
## License
MIT