https://github.com/ahmadnassri/node-oas-request-readme

oas-request docs generator
https://github.com/ahmadnassri/node-oas-request-readme

docs node oas openapi

Last synced: 3 months ago
JSON representation

oas-request docs generator

• Host: GitHub
• URL: https://github.com/ahmadnassri/node-oas-request-readme
• Owner: ahmadnassri
• License: mit
• Created: 2020-11-04T01:37:46.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-06-17T20:01:35.000Z (7 months ago)
• Last Synced: 2024-10-01T07:01:35.279Z (4 months ago)
• Topics: docs, node, oas, openapi
• Language: Makefile
• Homepage:
• Size: 151 KB
• Stars: 0
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# `oas-request` readme generator

`oas-request` readme generator

[![license][license-img]][license-url]

[![release][release-img]][release-url]

[![semantic][semantic-img]][semantic-url]

## Usage

Generates a Markdown summary of all `oas-request` client methods

``` bash

$ npx @ahmadnassri/oas-request-readme /path/to/spec.json

```

----

> Author: [Ahmad Nassri](https://www.ahmadnassri.com/) •

> Twitter: [@AhmadNassri](https://twitter.com/AhmadNassri)

[license-url]: LICENSE

[license-img]: https://badgen.net/github/license/ahmadnassri/node-oas-request-readme

[release-url]: https://github.com/ahmadnassri/node-oas-request-readme/releases

[release-img]: https://badgen.net/github/release/ahmadnassri/node-oas-request-readme

[semantic-url]: https://github.com/ahmadnassri/node-oas-request-readme/actions?query=workflow%3Arelease

[semantic-img]: https://badgen.net/badge/📦/semantically%20released/blue