Additional API schema documentation using markdown files

razum2um / lurker

📖 The ultimate tool for documenting and testing APIs in Rails

https://lurker.razum2um.me/lurker

MIT License

116 stars 22 forks source link

Closed nebolsin closed 9 years ago

nebolsin commented 9 years ago

Detailed documentation for services and endpoints can be provided by creating Markdown files next to the schema file.

lurker/Foo.service.yaml - lurker/Foo.service.md
lurker/api/bars-GET.json.yml - lurker/api/bars-GET.md
etc...

razum2um commented 9 years ago

:+1: