https://github.com/jaimerc/node-swagger

Estructura de una API en NodeJS con documentación de Swagger.
https://github.com/jaimerc/node-swagger

express nodejs swagger

Last synced: 3 months ago
JSON representation

Estructura de una API en NodeJS con documentación de Swagger.

• Host: GitHub
• URL: https://github.com/jaimerc/node-swagger
• Owner: JaimeRC
• Created: 2019-06-19T21:30:18.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2019-12-07T10:33:38.000Z (over 6 years ago)
• Last Synced: 2025-03-03T20:57:16.350Z (over 1 year ago)
• Topics: express, nodejs, swagger
• Language: JavaScript
• Homepage:
• Size: 425 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# node-swagger

Estructura de una API en NodeJS y documentación con Swagger.

## Estructura del Proyecto

    app.js                        # Archivo de inicializacion

      ├───api-docs                # Documentación e configuración de Swagger

      ├───config                  # Variable de entorno y constantes para el Proyecto

      ├───data                    # Datos para el proyecto y Readme

      ├───db                      # Conexión a las DBs

      ├───routes                  # Rutas  

      |     ├───controllers       # Controlladores para cada Ruta

      |     └───middleware        # Filtros y complementos para las Rutas

      ├───test                    # Archivos de Test

      └───utils                   # Scripts de utilidades para el proyecto

## Instalación

- Clona este repositorio: 

        git clone https://github.com/JaimeRC/node-swagger.git

- Ìnicializa el proyecto: 

        cd node-swagger

        npm install --save

        npm start

        

- Ve al navegador y muestra esta URL para ver la documentación: 

        http://localhost:9000/api-docs

## Imagenes

### Inicio

![Example](data/images/image0.png)

### Petición

![Example](data/images/image1.png)

### Modelos

![Example](data/images/image2.png)

## Licencia

node-swagger bajo [MIT License](https://opensource.org/licenses/MIT)