Skip to content

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

License

Notifications You must be signed in to change notification settings

iudx/iudx-api-doc-server

Repository files navigation

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

About

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

Resources

License

Stars

Watchers

Forks

Packages

No packages published