studies
Documentando API (Swagger e OpenAPI)
HomePrincípios de Programação Orientada a ObjetosTrabalhando com ObjetosTrabalhando com CollectionsTrabalhando com StringsTrabalhando com ExceptionsApi, camadas, CRUD, exceptions, validationProjeto Arquitetura RESTfulCriando um projeto REST / RESTfulSPRING DATA JPA - 2024Estudo Arquitetura LimpaEstudo sobre Anotações SpringModelo de Dominio e ORMAPI REST, camadas, CRUD, exceções, validaçõesJPA, Consultas SQL e JPQLLogin e controle de acessoTestes automatizados, JUnit5 e MockitoValidação e SegurançaSignup e finalizaçãoCobertura de testes com JaCoCoTestes API - MockMvc e RestAssuredEstudo Definitivo ORMEstudo upload arquivos AWSDocumentando API (Swagger e OpenAPI)Versionamento de APIHateoasWorkshop MongoDBWorkshop CassandraSpring Webflux - MongoDBSpring Batch - IntrodutórioSpring Batch Avançado - Lendo dados API remotaSpring Batch - Envio de Email em massaRoad map estudo
Documentando API (Swagger e OpenAPI)
HomePrincípios de Programação Orientada a ObjetosTrabalhando com ObjetosTrabalhando com CollectionsTrabalhando com StringsTrabalhando com ExceptionsApi, camadas, CRUD, exceptions, validationProjeto Arquitetura RESTfulCriando um projeto REST / RESTfulSPRING DATA JPA - 2024Estudo Arquitetura LimpaEstudo sobre Anotações SpringModelo de Dominio e ORMAPI REST, camadas, CRUD, exceções, validaçõesJPA, Consultas SQL e JPQLLogin e controle de acessoTestes automatizados, JUnit5 e MockitoValidação e SegurançaSignup e finalizaçãoCobertura de testes com JaCoCoTestes API - MockMvc e RestAssuredEstudo Definitivo ORMEstudo upload arquivos AWSDocumentando API (Swagger e OpenAPI)Versionamento de APIHateoasWorkshop MongoDBWorkshop CassandraSpring Webflux - MongoDBSpring Batch - IntrodutórioSpring Batch Avançado - Lendo dados API remotaSpring Batch - Envio de Email em massaRoad map estudo
  • Objetivo
  • Definição de documentação
  • Formas de Documentar
  • Especificações de documentação
  • Swagger
    • Classe config - customização
    • Recursos swagger (tags)
    • Anotações model (tags em DTO)
    • Swagger + Spring security
  • Readme
Fornecido por GitBook
Nesta página
  • Manual
  • Documentação a partir de ferramentas

Formas de Documentar

Manual

É recomendada para pequenas APIs; (Ex: readme github)

Em sistemas maiores, este processo é muito trabalhoso e demorado.

Documentação a partir de ferramentas

Agiliza o processo de documentação, além disso, mantém a API sempre atualizada e padronizada!

AnteriorDefinição de documentaçãoPróximoEspecificações de documentação

Atualizado há 5 meses