https://github.com/manoelcampos/swagger-ui-express-demo

Hello World com Node.js, expressjs, swagger-express-ui e swagger-jsdoc, mostrando como construir uma API REST e documentar usando Swagger.
https://github.com/manoelcampos/swagger-ui-express-demo

demo expressjs nodejs sample swagger swagger-jsdoc swagger-ui swagger-ui-express

Last synced: 11 days ago
JSON representation

Hello World com Node.js, expressjs, swagger-express-ui e swagger-jsdoc, mostrando como construir uma API REST e documentar usando Swagger.

• Host: GitHub
• URL: https://github.com/manoelcampos/swagger-ui-express-demo
• Owner: manoelcampos
• Created: 2020-05-19T19:27:11.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-02-11T12:07:17.000Z (almost 2 years ago)
• Last Synced: 2023-03-12T02:33:16.066Z (over 1 year ago)
• Topics: demo, expressjs, nodejs, sample, swagger, swagger-jsdoc, swagger-ui, swagger-ui-express
• Language: JavaScript
• Homepage: https://swagger-ui-express-demo.herokuapp.com
• Size: 801 KB
• Stars: 6
• Watchers: 1
• Forks: 5
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Hello World com Node.js, expressjs, swagger-express-ui e swagger-jsdoc

Mostra como criar uma aplicação de exemplo Node.js com [expressjs](http://expressjs.com)

e [swagger-ui-express](https://github.com/scottie1984/swagger-ui-express)

para gerar a interface web do Swagger para teste e documentação 

de APIs REST.

![](swagger-ui.png)

Inclui o módulo [swagger-jsdoc](https://github.com/Surnet/swagger-jsdoc)

para permitir especificar os endpoints implementados

com expressjs por meio de comentários [JSDoc](https://jsdoc.app/).

## Instalação

```bash

npm install

```

## Execução

```bash

npm start

```