diff --git a/README.md b/README.md index 2d8e38f..191e58e 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,28 @@ # **Código para ejecutar un especificación en OpenAPI** +En este ejemplo se utiliza NodeJS para crear un servicio utilizando el componente de Swagger +Para más información sobre OpenAPI se puede revisar la especificación en el siguiente URL: + +https://spec.openapis.org/oas/v3.0.0 + +Para más información sobre los códigos de estatuos de una llamada HTTP puede ver la siguiente liga: + +https://restfulapi.net/http-status-codes/ + + + ## Instalación -Utilice los componentes swa -Ejemplo de un servicio de OpenAPI con swagger \ No newline at end of file +USe requieren dos componentes el servidor los cuales se puede instalar con los siguientes comandos: + +```bash +npm install swagger-ui-express +npm install yamljs +``` + +Una vez instalado puede ejecutar con: + +```bash +node server.js +```