An API Documentation generator.
CSS HTML Python JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
coredocs
screenshots
theme-licenses
.gitignore
LICENSE.md
README.md
requirements.txt
setup.py

README.md

CoreDocs

An API Documentation generator.

  • Code sample generation - Automatic code samples for Python, Javascript, and the command line.
  • Schema support - Currently supports Swagger, RAML, and JSON HyperSchema.
  • Themes - Currently includes the 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

Swagger Screenshot

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

RAML Screenshot

Preview the generated documentation.