Write and share API documentation - Githubissues

Legmo / hotquotes

Single page application. React JS

GNU General Public License v3.0

3 stars 0 forks source link

Write and share API documentation #153

Open Legmo opened 2 years ago

Legmo commented 2 years ago

Write and share API documentation.

Use RAML syntax
Use API Designer or Anypoint Platform for create RAML documentation
Use raml2html or raml2wiki or RAML2Swagger for convert to other formats
Use API console for generate interactive API documentation.
Place API in web via static/interactive html files.
- API console example
- raml2html example
Update ReadMe file (product logos on «Technology stack» section, link on «Getting Started» section)
Update Contributing.md and Wiki.

Links:

RAML Site
RAML GitHub
API Designer editor
Anypoint Platform editor
raml2html converter
raml2wiki converter
RAML2Swagger converter
API console API-generator from RAML to HTML
https://www.mulesoft.com/exchange/
Habr - Пишем документацию API при помощи RAML
Справочник RAML