Herramientas de usuario
ada:howto:sicoferp:factory:migracionsicoferp:process:backend:guiadocmicroservicios
Diferencias
Muestra las diferencias entre dos versiones de la página.
| Ambos lados, revisión anterior Revisión previa | |||
|
ada:howto:sicoferp:factory:migracionsicoferp:process:backend:guiadocmicroservicios [2020/05/19 18:56] carlos.torres |
ada:howto:sicoferp:factory:migracionsicoferp:process:backend:guiadocmicroservicios [2020/05/19 19:02] (actual) carlos.torres |
||
|---|---|---|---|
| Línea 76: | Línea 76: | ||
| === Paso 5 === | === Paso 5 === | ||
| Documente las clases del microservicio con la especificación OAS((https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md)). Apoyese del proyecto modelo el cual tiene un ejemplo de configuración. | Documente las clases del microservicio con la especificación OAS((https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md)). Apoyese del proyecto modelo el cual tiene un ejemplo de configuración. | ||
| - | |||
| - | <code java> | ||
| - | //EJEMPLO CLASE PRINCIPAL | ||
| - | package co.ada.test.microservicio.pruebamodel; | ||
| - | |||
| - | import org.springframework.boot.SpringApplication; | ||
| - | import org.springframework.boot.autoconfigure.SpringBootApplication; | ||
| - | import org.springframework.boot.autoconfigure.domain.EntityScan; | ||
| - | import org.springframework.boot.builder.SpringApplicationBuilder; | ||
| - | import org.springframework.boot.web.servlet.support.SpringBootServletInitializer; | ||
| - | import org.springframework.cloud.netflix.eureka.EnableEurekaClient; | ||
| - | |||
| - | @EntityScan({"co.ada.models.microservicio.usuario", "co.ada.db.config"}) | ||
| - | @EnableEurekaClient | ||
| - | @SpringBootApplication | ||
| - | public class MicroservicioPruebaModelADAApplication extends SpringBootServletInitializer { | ||
| - | |||
| - | @Override | ||
| - | protected SpringApplicationBuilder configure(SpringApplicationBuilder application) { | ||
| - | return application.sources(MicroservicioPruebaModelADAApplication.class); | ||
| - | } | ||
| - | |||
| - | public static void main(String[] args) { | ||
| - | SpringApplication.run(MicroservicioPruebaModelADAApplication.class, args); | ||
| - | } | ||
| - | |||
| - | } | ||
| - | </code> | ||
| <code java> | <code java> | ||
| Línea 206: | Línea 178: | ||
| } | } | ||
| </code> | </code> | ||
| + | |||
| + | ==== Recomendaciones ==== | ||
| + | * Toda documentación debe ser clara y precisa. | ||
| + | * Toda entidad debe estar documentada en la especificación OAS para ser incluida en el Dominio de clases y Entidades Comunes. | ||
| + | * Todo Controller debe ser documentado mínimo en todas las operaciones expuestas. | ||
| + | * Cada operación expuesta debe documentar los códigos de retorno generados en el consumo. | ||
| + | |||
| [[ada:howto:sicoferp:factory:migracionsicoferp:process:backend|←Volver atrás]] | [[ada:howto:sicoferp:factory:migracionsicoferp:process:backend|←Volver atrás]] | ||
ada/howto/sicoferp/factory/migracionsicoferp/process/backend/guiadocmicroservicios.1589914571.txt.gz · Última modificación: 2020/05/19 18:56 por carlos.torres
Herramientas de la página
