mrjulio/rapture-restdoc

Rapture REST Documentation Generator

Maintainers

Details

github.com/mrjulio/rapture-restdoc

Homepage

Source

Issues

Installs: 12

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

v1.0.3 2017-11-18 20:58 UTC

Requires

  • php: >=7.0.4

MIT 908468470b7245151ba02a45e2ec1b2491a92372

library

This package is not auto-updated.

Last update: 2024-11-02 17:11:08 UTC

README

PhpVersion License

Generate a single file with REST docs from JSON files.

Check ./demo/src/*.json files for examples.

Requirements

  • PHP v7.0

Install

composer require mrjulio/rapture-restdoc

Quick start

cd ./scripts && php generate.php ./path/to/source/dir ./path/to/destination/index.html ./path/to/config.json

Roadmap

  • new theme
  • search box
  • better mobile support
  • PHP example
  • Python example
  • Go example

About

Author

Iulian N. rapture@iuliann.ro

License

Rapture PHP Router is licensed under the MIT License - see the LICENSE file for details.