mirror of https://github.com/sourcey/spectacle.git synced 2024-11-09 17:16:24 +03:00

Beautiful static documentation generator for OpenAPI/Swagger 2.0

Go to file

Vlad Tsepelev 4a8c3435ee Create x-spectacle-articles.hbs		2018-01-12 02:01:45 +01:00
app	Create x-spectacle-articles.hbs	2018-01-12 02:01:45 +01:00
bin	Fix typo/redundancy in usage string	2017-08-04 12:31:58 -04:00
public	Merge pull request #94 from svisser/fix_typos_cheese_store	2017-11-13 13:31:45 +01:00
test	Merge pull request #108 from yyamano/fix-typo	2017-11-30 18:23:01 +01:00
.gitignore	Make CSS templates more modular	2016-01-17 11:22:34 +10:00
Dockerfile	Add Dockerfile	2017-04-22 14:36:56 +02:00
index.js	Fix #65 parsing allOf definitions without type	2017-08-01 14:48:54 +02:00
LICENSE	Fix #36 add MIT licence	2017-03-01 10:51:14 +01:00
package.json	Make npm build work without global installation.	2017-12-07 23:06:53 +09:00
README.md	fix typo in README.md	2017-10-25 14:08:45 +08:00
screenshot.jpg	Update screenshot	2017-04-02 15:04:35 +02:00
TODO.md	Update swagger examples in the demo	2017-04-02 14:30:24 +02:00

README.md

Spectacle

The gentleman at REST

Spectacle generates beautiful static HTML5 documentation from OpenAPI/Swagger 2.0 API specifications.

The goal of Spectacle is help you "save time and look good" by providing an extensible platform for auto generating your REST API docs. The default layout is a three column single page, similar to those employed by Stripe and Intercom.

See a demo of Spectacle in action here: http://cheesestore.github.io

Features

OpenAPI/Swagger 2.0 support: Support for the latest OpenAPI/Swagger specification.
Highly configurable: Easily configurable Handlebars templates and SCSS styles so you can add your own design and flavour without going bald. See Custom Builds
Markdown support: Render markdown written in any of your API descriptions.
Clean responsive design: Responsive HTML5 and CSS3 layout built with Foundation 6 that looks great on all devices and screen sizes.
Embed into your existing website: An embedded option so that generate partial docs without a HTML <body> for convenient integration into your existing website.
Live preview developer mode: Development mode that starts a local HTTP server with a file watcher and live reload so you can preview live changes in your browser as you update your spec.

Usage

Simply install Spectacle from npm like so:

npm install -g spectacle-docs

Next pass your swagger.json document use the CLI to generate your documentation.

spectacle -d your_swagger_api.json

# Or use the cheese.json example to test it out
# spectacle -d -l test/fixtures/cheese.png test/fixtures/cheese.json

Your generated documentation will be located in the public directory by default. You can either copy the generated HTML to your web server, or view your docs by pointing your browser to http://localhost:4400/.

Docker

A basic Docker script is included that allows Spectacle to be run from the inside, not outside. It's useful, for instance, in a Gitlab CI pipeline. Thanks @alexeiaguiar.

How to use it: docker run -it sourcey/spectacle /bin/sh

Configuration Options

The basic CLI options are detailed below:

$ spectacle -h

  Usage: spectacle [options] <specfile>

  Options:

    -h, --help                output usage information
    -V, --version             output the version number
    -C, --disable-css         omit CSS generation (default: false)
    -J, --disable-js          omit JavaScript generation (default: false)
    -e, --embeddable          omit the HTML <body/> and generate the documentation content only (default: false)
    -d, --development-mode    start HTTP server with the file watcher and live reload (default: false)
    -s, --start-server        start the HTTP server without any development features
    -p, --port <dir>          the port number for the HTTP server to listen on (default: 4400)
    -t, --target-dir <dir>    the target build directory (default: public)
    -f, --target-file <file>  the target build HTML file (default: index.html)
    -a, --app-dir <dir>       the application source directory (default: app)
    -l, --logo-file <file>    specify a custom logo file (default: null)
    -c, --config-file <file>  specify a custom configuration file (default: app/lib/config.js)

Most options are self explanatory, but the following options warrant some further explanation:

--development-mode -d: This option starts a development server with a file watcher and live reload, and will automatically regenerate your docs when any of your spec or app files change.
--start-server -s: This option starts a production server without any development options enabled that serves the contents of your --target-dir.
--embeddable -e: This option lets you build a minimal version of the documentation without the HTML <body> tags, so you can embed Spectacle into your own website template. More info on custom builds here.
--app-dir -a: This option overrides the default directory which contains all the Handlebars templates, SCSS, and JavaScript source files. This option is useful for development because you can copy the contents of app to a remote location or a separate repo for custom builds.
--target-dir -t: This option specifies where the generated documentation HTML files will be output.

Custom Builds

The best option for building your own custom functionality into Spectacle is to fork Spectacle on GitHub, and make your own modifications in source. This way you can keep up to date by merging changes from the master branch, and your can also contribute your updates back to master by creating a Pull Request if you think they improve Spectacle somehow.

To fork Spectacle go to https://github.com/sourcey/spectacle, and press the 'Fork' button. Now you can git clone git@github.com:<yourname>/spectacle.git to make your own changes.

Alternatively, you can just copy the contents of app from the main repo which contains all the source files such as templates, stylesheets and JavaScripts. Now just pass the path to your custom app path to the CLI like so: spectacle -a /path/to/your/app your_swagger_api.json

Optimizing Your Workflow

Using an API spec to generate your docs has a number of great advantages, such as:

Maintain a single source: Save time by removing the need to maintain a separate API spec and API documentation.
No more out-of-date documentation: Your documentation will always be up-to-date with your API spec.
Be a better developer: Your entire API system will be more stable and robust when built around your spec as a single source of truth.

As developer we're always looking for ways to improve and optimize our workflow, and documentation is just the beginning. With a well written Swagger you can automate and generate many parts of your API system, such as:

Inline Code Generators: Generate your Swagger JSON or YAML from your source code comments.
Automate Testing: Automate testing for all your API endpoints.
Code Generation: Automatically generate client and server code from your spec.
Generate Documentation: Really?

For a list of open source Swagger based libraries in many languages check here: http://swagger.io/open-source-integrations/

Development

Testing

Testing is powered by Mocha/Chai, and automated testing is run via CircleCI.

At this stage, unit tests have not been written for all parts of the codebase. However, new code should be tested, and unit tests for the existing code will be added in the future.

Run npm test on the repository to start the automated tests. Some parts of testing can be configured using environment variables.

OFFLINE=true Some tests use HTTP connections to test giving Spectacle remote API specifications. Use OFFLINE=true to skip tests that require an internet connection.

Include environment variables before calling npm test. For example, OFFLINE mode can be enabled via OFFLINE=true npm test.