Aprenda como documentar APIs REST com a especificação OpenAPI.
Nível Iniciante Categoria Base para Devs
Documentar uma API é uma etapa muito importante do desenvolvimento de uma aplicação, pois é através da documentação que os nossos clientes ou outros membros da equipe saberão quais as rotas disponíveis em nossa API, quais os dados que ela espera receber e quais dados ela irá retornar. Uma API bem documentada nos trás uma maior produtividade no desenvolvimento de sistemas, uma vez que os times responsáveis pelo desenvolvimento das aplicações de Front-end e Mobile não terão a necessidade de esperar que a API esteja completa e no ar para então poderem desenvolver seus projetos e também não terão que entrar em contato constantemente com o time responsável pelo desenvolvimento da API para saberem como integrar com a mesma.
Para padronizar a escrita de documentação de uma API existe a especificação OpenAPI. O OpenAPI é uma especificação que suporta os formatos JSON e YAML para realizar a sua escrita e padroniza a maneira como documentamos uma API, a partir do arquivo de documentação que escrevemos seguindo as regras do OpenAPI podemos então gerar a documentação visual em qualquer ferramenta do tipo uma vez que todas suportam o OpenAPI pelo fato do mesmo ser uma padronização
Documentar uma API é uma etapa muito importante do desenvolvimento de uma aplicação, pois é através da documentação que os nossos clientes ou outros membros da equipe saberão quais as rotas disponíveis em nossa API, quais os dados que ela espera receber e quais dados ela irá retornar. Uma API bem documentada nos trás uma maior produtividade no desenvolvimento de sistemas, uma vez que os times responsáveis pelo desenvolvimento das aplicações de Front-end e Mobile não terão a necessidade de esperar que a API esteja completa e no ar para então poderem desenvolver seus projetos e também não terão que entrar em contato constantemente com o time responsável pelo desenvolvimento da API para saberem como integrar com a mesma.
Para padronizar a escrita de documentação de uma API existe a especificação OpenAPI. O OpenAPI é uma especificação que suporta os formatos JSON e YAML para realizar a sua escrita e padroniza a maneira como documentamos uma API, a partir do arquivo de documentação que escrevemos seguindo as regras do OpenAPI podemos então gerar a documentação visual em qualquer ferramenta do tipo uma vez que todas suportam o OpenAPI pelo fato do mesmo ser uma padronização
Neste curso abordaremos sobre como podemos documentar uma API utilizando a especificação OpenAPI. Além disso, veremos quais ferramentas podemos utilizar para escrever e visualizar nossas documentações e iremos documentar uma API real na prática com o OpenAPI.
São vídeo aulas e apostilas que mostram os principais conceitos da escrita de documentações com o OpenAPI. Também serão passados exercícios para que você possa fixar, praticar e aplicar o conteúdo aprendido durante o curso.
Dentre várias outras coisas, você será capaz de:
Esse curso é voltado para pessoas que desenvolvem APIs de todas as plataformas que desejam aprender como documentar suas APIs utilizando o OpenAPI.
Os pré-requisitos não são obrigatórios, são apenas sugestões. Eles dão uma base de parte do conhecimento que é interessante ter para um bom aproveitamento nesse curso.
Professor, programador, fã de One Piece e finge saber cozinhar. Cleyson é graduando em Licenciatura em Informática pelo IFPI - Campus Teresina Zona Sul, nos anos de 2019 e 2020 esteve envolvido em vários projetos coordenados pela secretaria municipal de educação da cidade de Teresina, onde o foco era introduzir alunos da rede pública no mundo da programação e robótica. Hoje é instrutor dos cursos de Spring e Django na TreinaWeb.
Introdução ao curso.
7 aulasNesta aula vamos conhecer a API que vamos documentar e também iniciar a documentação da mesma.
3 aulasNesta aula vamos documentar os endpoints relacionados ao processo de autenticação da nossa API.
3 aulasNesta aula vamos documentar os endpoints relacionados ao CRUD de objetos da nossa API.
8 aulasÓtimo curso dinâmica perfeita, todo feito na pratica,
Muito bom , parabéns!
òtimo curso! Super detalhado e handson!
Curso bem objetivo, muito bom.
Gostei bastante do curso, acredito que somou bastante com meus conhecimentos e os projetos projetos terei uma documentação mais rica e padronizada.
Muito bom, conteúdo bem explicado !
Excelente curso sobre OpenAPI... com ótimos exemplos... Parabéns a todos os envolvidos.
Ótimas aulas, conteúdo muito bem explicado, assunto muito útil para formar uma boa base pro dev, também amei a formulação dos exercícios, consegui aprender bastante!
Otimo, boa didatica e otima explicação.
Tenha um ano de acesso completo a todos os cursos da plataforma, incluindo novos lançamentos, mentoria de carreira e suporte direto com os professores!
Contrate agora e tenha acesso ilimitado a todo o nosso portfólio. Isso inclui:
Confiamos tanto nos resultados dos nossos cursos, que criamos uma garantia incondicional de satisfação para você, que são 7 dias de teste!
