@anli/api-doc
v3.0.1
Published
API Doc creates API Documentation written in OpenAPI Specification (OAS).
Readme
API Doc
API Doc creates API Documentation written in OpenAPI Specification (OAS).
Getting started
Initialize the project
mkdir tmp
cd tmp
npm init -y
npm install @anli/api-doc
npx api-doc-initCreate the passphrase in the .env file
echo "PASSWORD=your-password" >> .envUpdate src/index.html and/or src/open-api.yaml accordingly
Build the documentation
npx api-docView the documentation
open dist/index.htmlFeatures
- Generate API Documentation from
.yamlfile - View with SwaggerUI
- Protected with AES-256 encryption passphrase
Contributing
If you'd like to contribute, please fork the repository and use a feature branch. Pull requests are warmly welcome.
Links
Licensing
The code in this project is licensed under MIT license.
