🔏
starhackit
  • README
  • Getting started
    • Requirements
    • Quick Start
  • Frontend
    • The Frontend
      • Npm scripts
    • Unit testing
    • End 2 End Testing
    • Multi Application
    • Production Build
    • Internationalization
    • Configuration
    • Cut and Paste detector
    • Webpack
  • Backend
    • Node Backend
      • Npm scripts
    • Development Enviromnent with docker-compose
    • Testing
      • Code Coverage
    • Configuration
    • Debugging
    • Database
    • Http Server
      • CORS
    • Authentication
      • Social Authentication
      • Local Authentication with JWT
    • Email
    • Redis
    • Api Model
      • Api Mocking
  • Deployment
    • Build, Tag and Push Docker Images
    • Releasing
    • Deploy Infrastructure with GruCloud
    • Deploy with Ansible
Powered by GitBook
On this page

Was this helpful?

  1. Backend

Api Model

PreviousRedisNextApi Mocking

Last updated 5 years ago

Was this helpful?

The REST API implemented by this backend is designed and modeled with which stands for Rest API Modeling Language. From a file describing the API such as the , several dedicated tools will perform the following benefits:

  • npm run doc: The

  • npm run mocker: A mock server that will responds to web browser according the API specification, useful for frontend developers which can start before the backend is fully implemented.

  • A mock client which verifies that the backend implemented correctly the API.

REST API HTML documentation

The REST API HTML documentation is generated with the following command:

# npm run doc

The result can be found at build/api.html

Behind the scene npm run doc invokes:

# node scripts/apidoc.js

To open the documentation, simply run

# npm run opendoc
RAML
user's API
API documentation in HTML