https://github.com/bhawanihmh/raml
RAML for API Documentations
https://github.com/bhawanihmh/raml
raml raml-build raml-document raml-documentation raml-example raml-sample raml-to-html ramltohtml
Last synced: 3 months ago
JSON representation
RAML for API Documentations
- Host: GitHub
- URL: https://github.com/bhawanihmh/raml
- Owner: bhawanihmh
- Created: 2017-10-06T08:46:29.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-02-23T13:03:08.000Z (about 5 years ago)
- Last Synced: 2025-01-05T09:44:13.058Z (5 months ago)
- Topics: raml, raml-build, raml-document, raml-documentation, raml-example, raml-sample, raml-to-html, ramltohtml
- Language: HTML
- Size: 2.51 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# RAML
RAML stands for RESTful API Modeling Language. It's a way of describing practically-RESTful APIs in a way that's highly readable by both humans and computers.
Please Refer : https://raml.org/about-raml
This example for API Documentations using JSON, RAML, XSD Schemas.
Installation Steps:
1. Install Node. Path: https://nodejs.org/en/download/
2. Install ATOM. Path : https://atom.io/
3. Run below commands.
3.1 apm config set strict-ssl null
3.2 apm install api-workbench
3.3 npm i -g raml2html
3.4 npm install -g raml-cop
3.5 apm install -g raml-cop
3.6 npm install -g ramltojaxrs
3.7 apm install -g ramltojaxrs
To generate HTML please run below command:
raml2html COMPANIES.raml > COMPANIES.html
org.powermock
powermock-module-junit4-rule-agent
1.7.3
test