Skip to content

Latest commit

 

History

History
59 lines (37 loc) · 1.23 KB

README.md

File metadata and controls

59 lines (37 loc) · 1.23 KB
Raw

Schema build status

Swagger schema for ADAMANT Node API

The specification creates a RESTful interface for easily developing and consuming an API by effectively mapping all the resources and operations associated with it.

https://schema.adamant.im

Bootstrap

Install dependencies via npm:

$ npm install

then start dev server:

$ npm run start
# or
$ npm run start:watch # watches changes in the /specification dir

Commands

To build the schema into a single file dist/schema.json, run:

$ npm run bundle

Once the schema is built you can run the server:

$ npm run start

You should now have the Swagger UI running at http://localhost:3000.

JSON Schema is available under http://localhost:3000/schema.json

Example

You can use this schema to generate API types for TypeScript:

$ cd examples/axios

$ npm install

# TS types will be generated in `examples/axios/client` dir
$ npm run openapi:generate

Links