Curso de OpenAPI - Documentando APIs

Aprenda como documentar APIs REST com a especificação OpenAPI.

Nível Iniciante Categoria Base para Devs

  • Curso com 01h51 de videos
  • Certificado com 6 horas
  • 12 exercícios

Sobre o curso

Aprenda como documentar APIs REST com a especificação OpenAPI.

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

O que irá aprender?

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:

  • Entender a importância de escrever documentações;
  • Entender o que o que é o OpenAPI;
  • Escrever documentação de uma API.

Pra quem é esse curso?

Esse curso é voltado para pessoas que desenvolvem APIs de todas as plataformas que desejam aprender como documentar suas APIs utilizando o OpenAPI.

Quais os pré-requisitos para esse curso?

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.

Metodologia

  • Videoaulas
  • Texto e imagens
  • Início Imediato
  • Testes de aprendizado

Ambiente do curso

  • Insomnia 2.8

Sobre o professor

Cleyson Lima

Cleyson Lima

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 na TreinaWeb, mas diz que seu coração sempre pertencerá ao Python.

Conteúdo programático

  1. Introdução

    Introdução ao curso.

    7 aulas
    • Apresentação
    • Porquê documentar uma API?
    • O que é o OpenAPI?
    • O que é JSON?
    • O que é YAML?
    • Ferramentas para escrever e visualizar documentações
    • Questionário
  2. Iniciando a documentação de uma API

    Nesta aula vamos conhecer a API que vamos documentar e também iniciar a documentação da mesma.

    3 aulas
    • Qual API vamos documentar?
    • Documentando as informações iniciais da API
    • Questionário
  3. Documentando o endpoints de autenticação

    Nesta aula vamos documentar os endpoints relacionados ao processo de autenticação da nossa API.

    3 aulas
    • Documentando o endpoint de login
    • Documentando o endpoint de refresh
    • Questionário
  4. Documentando os endpoints de objeto

    Nesta aula vamos documentar os endpoints relacionados ao CRUD de objetos da nossa API.

    8 aulas
    • Documentando como ocorrerá a autenticação
    • Documentando o endpoint de cadastro do objeto
    • Documentando o endpoint de listagem do objetos
    • Documentando o endpoint de detalhes do objeto
    • Documentando o endpoint de edição do objeto
    • Documentando o endpoint de exclusão do objeto
    • Documentando o endpoint de atualização da foto do objeto
    • Questionário
Download da ementa

Utilizada e amada por milhares! Veja mais opiniões reais

  • Gostei bastante do curso. O suporte é muito bom e rápido, sempre que tive algum problema achei respostas nos tickets. Pretendo até fazer outros cursos como Javascript, HTML5 e CSS3 para dar um complemento neste daqui. Obrigado, TreinaWeb! Já posso pedir aumento na empresa (rs)!

    Depoimento - Márcus
    PhoneGap - Apache Cordova Mobile Framework
    Márcus Montes Claros / MG
  • O curso, sem sombras de dúvidas, é um dos melhores da TreinaWeb. Estou muito satisfeito com o conhecimento adquirido e gostaria de elogiar o tutor/professor por ser direto ao ponto e trazer explicações práticas sobre o tema sem muita enrolação. Parabéns.

    Depoimento - Glaydson
    ITIL - Fundamentos - Parte 2
    Glaydson Recife / PE
  • O professor tem uma didática de fácil compreensão, mesmo para quem está vendo o assunto pela primeira vez. Eu cheguei na TreinaWeb através de um curso de Spring, e sem sombra de dúvida, está sendo um excelente investimento. Bora para o próximo, afinal o mercado é exigente!

    Depoimento - Moises
    Java - Fundamentos de Struts 2
    Moises Jaguariúna / SP
  • Curso muito funcional e objetivo. Ensina perfeitamente como fazer as configurações necessárias, embora para melhor entendimento exija um pouco de conhecimento do aluno. Vídeos muito bem elaborados e excelente professor. Valeu a pena aprimorar meus conhecimentos.

    Depoimento - Bruno
    Windows Server 2016 - Active Directory
    Bruno São Lourenço da Mata / PE
  • Melhor plataforma educativa para o âmbito profissional em relação as demais do mercado. Aqui encontrei didática, suporte e o mais importante consegui entender tudo o que era proposto nas aulas, supriu e está a suprir mais as minhas necessidades acadêmicas e pessoais. Obrigado TreinaWeb por proporcionar tudo isso.

    Depoimento - Fabiano
    HTML5 e CSS3 - Desenvolvimento web Básico
    Fabiano Hortolândia / SP
  • Um curso com uma excelente metodologia e instrutor. O conteúdo abortado é importantíssimo atualmente para o mercado de trabalho, e foi apresentado de forma simples e objetiva, ocasionando em fácil interpretação e aprendizado.

    Depoimento - Leonardo
    CSS - Sass
    Leonardo Itaquaquecetuba / SP
  • Estudar HTML5 e CSS3 foi um prazer, foi desafiador. Quebrei bastante minha cabeça para resolver alguns problemas simples como, por exemplo, a sintaxe correta para endereçamento do background-image: url(' '). Gossssshhhhh, como eu demorei para encontrar um erro tao besta, mas o fato e que programar é isso mesmo, ter paciência e os cursos aqui na TreinaWeb estão sendo bons duas vezes mais para mim, que sou estudante de Engenharia da Computação. Digo isso porque embora tenhamos um suporte nota 1000 e instrutores muito bem treinados e que entendem do assunto, você ainda adquire a habilidade de resolver problemas de maneira espontânea. Quero dizer que, o verdadeiro programador pelo menos corre atras das suas dúvidas, esgota todas as possibilidades, para só então recorrer ao suporte, e para ser honesto, tenho cadastro em outros concorrentes de cursos online da TreinaWeb, mas só aqui encontro o respaldo teórico e pratico para uma formação sólida!

    Depoimento - Raphael
    HTML5 e CSS3 - Desenvolvimento web Básico
    Raphael Presidente Prudente / SP
  • O Curso é muito completo, a didática do professor é ótima, o suporte é maravilhoso, tiram todas as dúvidas e oferecem total atenção. Estou ansioso para começar o próximo curso. Parabéns, TreinaWeb, continuem assim.

    Depoimento - Lucas
    Lógica de Programação Completo
    Lucas Santa Fé do Sul / SP
  • Gostei muito do curso, ganhei esse cadastro graças a uma promoção estou tendo o acesso gratuito por um mês, é provável que eu vá assinar a plataforma mais a diante, a dinâmica na qual se aborda sobre o conteúdo é realmente incrível.

    Depoimento - Naum
    Java - Stream API
    Naum Caucaia / CE

Plano de acesso total!

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!

Um ano de acesso completo

Contrate agora e tenha acesso ilimitado a todo o nosso portfólio. Isso inclui:

  • 1 ano de acesso a todos os cursos
  • Cursos novos toda semana
  • Suporte direto com professores
  • Aplicativos para Android e iOS
  • Plano de carreira personalizado
  • Certificados digitais inclusos
  • Suporte com SLA de 4 horas úteis
  • Acesso offline através dos apps
Por apenas
12x R$ 75,00 ou R$ 900,00 à vista
Matricule-se agora
Garantia incondicional de satisfação
Garantia incondicional de satisfação

Confiamos tanto nos resultados dos nossos cursos, que criamos uma garantia incondicional de satisfação para você, que são 7 dias de teste!