https://github.com/aperkaz/express-open-api

Express with OpenAPI setup
https://github.com/aperkaz/express-open-api

express openapi

Last synced: about 2 months ago
JSON representation

Express with OpenAPI setup

• Host: GitHub
• URL: https://github.com/aperkaz/express-open-api
• Owner: aperkaz
• License: mit
• Created: 2021-04-02T14:54:02.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-02-21T08:56:14.000Z (almost 3 years ago)
• Last Synced: 2024-08-01T22:01:33.876Z (5 months ago)
• Topics: express, openapi
• Language: JavaScript
• Homepage: https://www.freecodecamp.org/news/how-to-build-explicit-apis-with-openapi/
• Size: 257 KB
• Stars: 20
• Watchers: 5
• Forks: 17
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Express OpenAPI

Code for the article: 

This codebase shows how to build an [OpenAPI](https://www.openapis.org/)-backed [express](https://expressjs.com/) application.

## How to run

```bash

# Install dependencies

npm i

# Run app

npm run start

```

## Dynamic API documentation

Thanks to its OpenAPI compliance, the app auto-generates the documenation of the API on the fly.

Available in , while the app is running.

![doc-image](./doc-image.png)

## License

MIT © [Alain Perkaz](https://aperkaz.github.io)