Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/andresweitzel/microservice_cisco_devices_graphql

Microservice for managing Cisco devices implemented with GraphQL, Express, Apollo, NestJS, Typescript, NodeJS, TypeORM, dotenv, cors, swagger, swagger-ui, MySQL, others.
https://github.com/andresweitzel/microservice_cisco_devices_graphql

apollo-graphql apollo-server-express cisco cisco-api cors dotenv express-js expressjs graphql microservicios mysql nestjs nestjs-graphql nodejs swagger-ui typeorm typescript

Last synced: about 1 month ago
JSON representation

Microservice for managing Cisco devices implemented with GraphQL, Express, Apollo, NestJS, Typescript, NodeJS, TypeORM, dotenv, cors, swagger, swagger-ui, MySQL, others.

Host: GitHub
URL: https://github.com/andresweitzel/microservice_cisco_devices_graphql
Owner: andresWeitzel
License: gpl-3.0
Created: 2023-07-26T03:16:13.000Z (over 1 year ago)
Default Branch: master
Last Pushed: 2024-04-23T22:44:06.000Z (9 months ago)
Last Synced: 2024-04-23T23:52:53.605Z (9 months ago)
Topics: apollo-graphql, apollo-server-express, cisco, cisco-api, cors, dotenv, express-js, expressjs, graphql, microservicios, mysql, nestjs, nestjs-graphql, nodejs, swagger-ui, typeorm, typescript
Language: TypeScript
Homepage:
Size: 2.24 MB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        ![Index app](https://github.com/andresWeitzel/Microservice_Cisco_Devices_GraphQL/blob/master/doc/assets/img/readme/graphql_microservice.jpg)

# Microservicio\_Cisco\_Devices\_GraphQL

Microservicio para el manejo de dispositivos cisco implementado con GraphQL, Express, Apollo, NestJS, Typescript, NodeJS, TypeORM, Dotenv, Cors, Swagger, Swagger-ui, MySQL, Otros.

*   [Repositorio microdb\_cisco\_devices\_mysql](https://github.com/andresWeitzel/Microdb_Cisco_Devices_Mysql)

*   [Playlist prueba de funcionalidad](https://www.youtube.com/playlist?list=PLCl11UFjHurC4DVGjeTuUOID0gjVxGDd3)

*   Api Rest Documentation Cisco

    *   [Devices](https://developer.cisco.com/docs/control-center/#!devices)

    *   [Rate Plans](https://developer.cisco.com/docs/control-center/#!get-rate-plans/response-example)

    *   [Status Devices](https://pubhub.devnetcloud.com/media/control-center-sandbox/docs/Content/api/rest/get_started_rest.htm#api_sim_status)

    *   [Device Audit History](https://developer.cisco.com/docs/control-center/#!get-device-audit-history/get-device-audit-history)

    *   [Device Usage](https://developer.cisco.com/docs/control-center/#!get-device-usage/response-example)

    *   [Devices Usage By Zone](https://developer.cisco.com/docs/control-center/#!get-device-usage-by-zone/response-example)




## Índice 📜

  Ver 

 


### Sección 1) Descripción, configuración y tecnologías.

*   [1.0) Descripción del Proyecto.](#10-descripción-)

*   [1.1) Ejecución del Proyecto.](#11-ejecución-del-proyecto-)

*   [1.2) Configuración del proyecto desde cero](#12-configuración-del-proyecto-desde-cero-)

*   [1.3) Comandos de utilidad.](#13-comandos-de-utilidad)

*   [1.4) Tecnologías.](#14-tecnologías-)

### Sección 2) Endpoints y Ejemplos

*   [2.0) EndPoints y recursos.](#20-endpoints-y-recursos-)

*   [2.1) Ejemplos.](#21-ejemplos-)

### Sección 3) Prueba de funcionalidad y Referencias

*   [3.0) Prueba de funcionalidad.](#30-prueba-de-funcionalidad-)

*   [3.1) Referencias.](#31-referencias-)







## Sección 1) Descripción, configuración y tecnologías.

### 1.0) Descripción [🔝](#índice-)

  Ver

 


### 1.0.0) Descripción General

### 1.0.1) Descripción Arquitectura y Funcionamiento




### 1.1) Ejecución del Proyecto [🔝](#índice-)

  Ver










### 1.2) Configuración del proyecto desde cero [🔝](#índice-)

  Ver




*   Creamos un entorno de trabajo a través de algún ide, luego de crear una carpeta nos posicionamos sobre la misma

```git

cd 'projectName'

```

*   Instalamos la última versión LTS de [Nodejs(v18)](https://nodejs.org/en/download)

*   Instalamos NestJS de forma global

```git

npm i -g @nestjs/cli

```

*   Creamos un proyecto Nest

```git

nest new nombreProyecto

```

*   Creamos un proyecto Nest

```git

nest new nombreProyecto

```

*   Crear un nuevo modulo sin test

```git

nest g mo moduleName --no-spec

```

*   Crear un nuevo servicio sin test

```git

nest g s moduleName --no-spec

```

*   Crear un nuevo resolver (controlador) sin test

```git

nest g co moduleName --no-spec

```

*   Podemos automatizar los archivos anteriores con graphql usando un resource( Esto creara entities,services,module, resolvers)

```git

nest g resource resourceName --no-spec

```

```git

- Seleccionamos los siguientes valores

- ? What transport layer do you use? GraphQL (code first)

- ? Would you like to generate CRUD entry points? Yes

```

*   Instalamos el plugin para [dotenv (variables de entorno)](https://www.npmjs.com/package/dotenv)

```git

npm i dotenv

```

*   Instalamos el plugin para [TypeORM](https://typeorm.io/) junto con el controlador de mysql para el mapeo de datos.

```git

npm i @nestjs/typeorm typeorm mysql2

```

*   Para el uso del orm, podemos seguir la [guía de configuración de typeorm para db](https://docs.nestjs.com/recipes/sql-typeorm).

*   Instalamos el plugin de nest con [swagger](https://docs.nestjs.com/openapi/introduction) paa la documentación de nuestra Api rest.

```git

npm i @nestjs/swagger

```

*   Instalamos el plugin [class-validator](https://www.npmjs.com/package/class-validator)  para validaciones de tipos de datos, propiedades de clases,  etc.

```git

npm i class-validator

```

*   Se resume instalación de plugins para acotar documentación. Para la totalidad de los mismos revisar `package.json`.

*   Ejecutamos la app desde terminal.

```git

npm run start:dev

```

*   Entramos a la interfaz de Gaphql por defecto para las peticiones de la Api.

```git

http://localhost:3200/graphql o http://localhost:3300/graphql

```




### 1.3) Comandos de utilidad [🔝](#índice-)

  Ver

 


*   Crear un nuevo proyecto NestJs

```git

nest g projectName

```

*   Crear un nuevo modulo sin test

```git

nest g mo moduleName --no-spec

```

*   Crear un nuevo servicio sin test

```git

nest g s moduleName --no-spec

```

*   Crear un nuevo controlador sin test

```git

nest g co moduleName --no-spec

```

*   Podemos automatizar los archivos anteriores con graphql usando un resource( Esto creara entities,services,module, resolvers)

```git

nest g resource resourceName --no-spec

```

```git

- Seleccionamos los siguientes valores

- ? What transport layer do you use? GraphQL (code first)

- ? Would you like to generate CRUD entry points? Yes

```




### 1.4) Tecnologías [🔝](#índice-)

  Ver

 


| **Tecnologías** | **Versión** | **Finalidad** |\

| ------------- | ------------- | ------------- |

| [NodeJS](https://nodejs.org/en/) | 14.18.1  | Librería JS |

| [NestJS](https://nestjs.com/) | ^10.0.0 | Framework de NodeJS |

| [Typescript](https://www.typescriptlang.org/) | 3.8.3  | Lenguaje con alto tipado basado en JS |

| [TypeORM](https://typeorm.io/) | ^0.3.17 | ORM |

| [Mysql](https://www.mysql.com/) | 10.1 | SGDB |

| [XAMPP](https://www.apachefriends.org/es/index.html) | 3.2.2 | Paquete de servidores |

| [Swagger](https://docs.nestjs.com/openapi/introduction) | ^7.1.2 | Documentación de Api |

| [VSC](https://code.visualstudio.com/docs) | 1.72.2  | IDE |

| [Postman](https://www.postman.com/downloads/) | 10.11  | Cliente Http |

| [CMD](https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/cmd) | 10 | Símbolo del Sistema para linea de comandos |

| [Git](https://git-scm.com/downloads) | 2.29.1  | Control de Versiones |

| **Extensión** |\

| -------------  |

| Prettier - Code formatter |

| Typescript Toolbox - generate setters, getters, constrc, etc |

| Otras |







## Sección 2) Endpoints y Ejemplos.

### 2.0) Endpoints y recursos [🔝](#índice-)

  Ver




### 2.1) Ejemplos [🔝](#índice-)

  Ver










## Sección 3) Prueba de funcionalidad y Referencias.

### 3.0) Prueba de funcionalidad [🔝](#índice-)

  Ver







### 3.1) Referencias [🔝](#índice-)

  Ver

 


#### GraphQL Api

*   Tutorials

    -[Api rest example](https://www.youtube.com/watch?v=geYvdbpo3cA)

#### @nestjs/graphql

*   Tutorials

    *   [Tutorial Base](https://www.youtube.com/watch?v=ms0WcT2MJg4\&t=11s)

*   Installation/tutorial

    *   [Librerías y tutorial Graphql + Nestjs](https://docs.nestjs.com/graphql/quick-start)

    *   [Tipos de datos](https://graphql.org/learn/schema/)

    *   [Paginados y filtros](https://github.com/Adrinalin4ik/Nestjs-Graphql-Tools)

    *   [Argumentos/parametros/query params](https://the-guild.dev/graphql/yoga-server/tutorial/advanced/03-advanced-sorting)

    *   [Argumentos](https://ru-nestjs-docs.netlify.app/graphql/resolvers-map)

#### Nestjs

*   Videotutorials

    *   [Videotutorial base](https://www.youtube.com/watch?v=W4_oH3anYHU)

    *   [Videotutorial Typeorm](https://www.youtube.com/watch?v=JaTbzPcyiOE)

    *   [Mastering Nest.js](https://www.youtube.com/playlist?list=PLkZU2rKh1mT-3VvYvGCdRVCCJ5lCtOKED)

*   Topics

    *   [Using async and promises](https://subscription.packtpub.com/book/programming/9781800204737/10/ch10lvl1sec89/asynchronous-handlers)

    *   [Query parameters and parameters](https://stackoverflow.com/questions/54958244/how-to-use-query-parameters-in-nest-js)

    *   [Using query parameters](https://dev.to/nandhakumar/nest-js-tutorial-3-query-route-params-3gi4)

    *   [Autovalidation in NestJS](https://docs.nestjs.com/techniques/validation)

#### Typeorm

*   Relations

    *   [Typeorm Relationships with cascade](https://stackoverflow.com/questions/55098023/typeorm-cascade-option-cascade-ondelete-onupdate)

    *   [Using Foreign keys tutorial](https://leoromanovsky.medium.com/a-blog-without-an-author-typeorm-creates-confusion-with-required-columns-and-optional-foreign-keys-1a3f932d4e67)

    *   [Using Foreign keys stackoverflow](https://stackoverflow.com/questions/68556933/typeorm-insert-foreign-key-by-string)

    *   [Using Providers with Nestjs](https://docs.nestjs.com/recipes/sql-typeorm)

*   Methods

    *   [findOne, find, filter,etc](https://desarrolloweb.com/articulos/metodo-find-repositorios-typeorm)

    *   [Check pagination,etc](https://stackoverflow.com/questions/53922503/how-to-implement-pagination-in-nestjs-with-typeorm)

    *   [Rest Methods](https://docs.nestjs.com/techniques/database)

#### Api example code

*   [Ap rest graphql+typeorm+nestjs](https://blog.logrocket.com/how-to-build-a-graphql-api-with-nestjs/)

*   [Api completa MVC (CHECK)](https://github.com/amitavdevzone/nest-js-quiz-manager/tree/master)

*   [Api example tutorial](https://stackabuse.com/guide-to-nestjs-building-a-rest-api-with-nest-and-node/)

*   [Nestjs Rest example code](https://github.com/hantsy/nestjs-rest-sample/blob/master/docs/guide.md)

*   [OFICIAL CRUD NESTJS](https://docs.nestjs.com/recipes/crud-generator)

#### OpenApi and Swagger

*   [Code settings](https://docs.nestjs.com/openapi/introduction)

*   [Code example](https://github.com/nestjs/nest/blob/master/sample/11-swagger/src/cats/entities/cat.entity.ts)

#### Librerías

*   [Validación de campos](https://www.npmjs.com/package/node-input-validator)

*   [Validación de propiedades de clases](https://www.npmjs.com/package/class-validator)

*   [Variables de entorno con dotenv typescript](https://medium.com/@glasshost/define-types-for-process-env-in-typescript-c89b3c8ffbb2)