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

  • Curso bem objetivo, muito bom.

    Depoimento - Diego
    OpenAPI - Documentando APIs
    Diego Nova Friburgo / RJ
  • Ótimo curso dinâmica perfeita, todo feito na pratica,

    Depoimento - João
    OpenAPI - Documentando APIs
    João Paranavaí / PR
  • Ó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!

    Depoimento - Alan
    OpenAPI - Documentando APIs
    Alan Riacho das Almas / PE
  • Muito bom!!!

    Depoimento - Renato
    OpenAPI - Documentando APIs
    Renato São Paulo / SP
  • Otimo, boa didatica e otima explicação.

    Depoimento - Tadeu
    OpenAPI - Documentando APIs
    Tadeu Petrolina / PE
  • O curso oferece tudo que alguém precisa para aprender, o resto é por conta do aluno em se dedicar. Meu primeiro curso concluído na TreinaWeb e fiquei com uma boa impressão. Estou animado para mais cursos.

    Depoimento - Frank
    Lógica de Programação Completo
    Frank São João do Oeste / SC
  • Gostei muito do curso. Fiz para revisar alguns conhecimentos e percebi que haviam coisas que eu não sabia, e faz sentido estar categorizado como Base para Devs: saber utilizar o REST desde o começo evita dores de cabeça lá na frente. E a didática do professor é muito boa.

    Depoimento - Karyna
    APIs Rest - Fundamentos
    Karyna São Paulo / SP
  • Excelente curso. Sem enrolação direto ao ponto, mudou totalmente a minha percepção sobre Slim e sobre a TreinaWeb. Gostei muito da maneira de ensino, cada aula um objetivo com inicio meio e fim, e ainda de quebra um exemplo prático muito bacana. Parabéns =]

    Depoimento - Andre
    Slim - Microframework PHP
    Andre Maringá / PR
  • É com imensa satisfação que deixo mais um depoimento sobre um curso da TreinaWeb. É chato ser repetitivo, mas quando é para retificar algo com tamanha excelência eu acho relevante. O Curso de Introdução ao Angular é mais um produto com o Selo de Qualidade TreinaWeb, no que diz respeito à didática e, também, nas aulas em textos e vídeos. Sensacional! Recomendo fortemente!!! Carlos A Santos

    Depoimento - Carlos
    Angular - Introdução
    Carlos Rio de Janeiro / RJ

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!