/iudx-api-doc-server

This tool will use yaml files to generate API Docs for IUDX entities like Catalogue, Auth, Resource Server etc.

Primary LanguageHTMLGNU General Public License v3.0GPL-3.0

IUDX API Docs

This tool will use yaml files to generate API Docs for IUDX entities like Catalogue, Auth, Resource Server etc.

Setup

git clone https://github.com/rbccps-iisc/iudx-api-doc-server
cd iudx-api-doc-server
npm install

NOTE: Place the server certificate and key in cert/ directory for enabling https connection. Name the certificate as server.pem and key as key.pem. This nomenclature is necessary.

Development Server

npm test

The server will be listening at https://localhost:11443

Production Server

npm start

The server will be listening at https://localhost

Author

Jishnu P

Contributors

Visit this page to view all contributors