Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/core-api/coredocs
An API Documentation generator.
https://github.com/core-api/coredocs
Last synced: about 1 month ago
JSON representation
An API Documentation generator.
- Host: GitHub
- URL: https://github.com/core-api/coredocs
- Owner: core-api
- License: other
- Created: 2016-12-01T10:42:46.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2021-03-29T17:04:27.000Z (over 3 years ago)
- Last Synced: 2024-07-19T06:08:19.536Z (about 2 months ago)
- Language: CSS
- Size: 715 KB
- Stars: 23
- Watchers: 3
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- starred-awesome - coredocs - An API Documentation generator. (CSS)
README
# CoreDocs
An API Documentation generator.
* **Code sample generation** - Automatic code samples for Python, Javascript, and the command line.
* **Schema support** - Currently supports [Swagger][swagger], [RAML][raml], and [JSON HyperSchema][jsonhyperschema].
* **Themes** - Currently includes the [Slate][slate] API documentation theme.
Additional themes and support for theme customization is planned.
## Swagger example
The following will build API documentation for the Swagger "PetStore" example API.
$ pip install coredocs
$ pip install openapi-codec
$ coredocs build http://petstore.swagger.io/v2/swagger.json --format openapi
Preview the generated documentation.
## RAML example
The following will build API documentation for the Spotify API, based on their RAML schema.
$ pip install coredocs
$ pip install raml-codec
$ coredocs build https://raw.githubusercontent.com/spotify/web-api/master/specifications/raml/api.raml --format raml
Preview the generated documentation.
[swagger]: http://swagger.io/
[raml]: http://raml.org/
[jsonhyperschema]: http://json-schema.org/latest/json-schema-hypermedia.html
[slate]: https://github.com/lord/slate