Certo, na
tela, tenho a conta do GitHub para a especificação OpenAPI.
Portanto, é aqui que se encontra todo o código-fonte por trás da OpenAPI.
Ele fica dentro deste repositório do GitHub.
Fornecerei um link para isso nos recursos do curso para que você possa acessá-lo aqui.
Agora, há algumas coisas que quero destacar aqui especificamente
para o curso que vamos analisar. Se você entrar aqui e der uma olhada no diretório de exemplos dentro do GitHub,
verá que temos a versão 2. 0 e 3. 0.
Mais uma vez, não estou me concentrando na 2. 0, mas vou olhar para o 3. 0.
Aqui estão alguns exemplos diferentes.
Lembre-se de que vimos a petstore, então aqui está a petstore. O YAML tem a especificação OpenAPI.
Você pode ver que há várias implementações diferentes da especificação OpenAPI que podemos analisar.
Portanto, quando precisar ver como fazer alguma coisa, você
pode analisar esses exemplos e voltar para cá. A próxima coisa que queremos dar uma olhada aqui são as IMPLEMENTAÇÕES, esse
arquivo de marcação aqui IMPLEMENTAÇÕES. Essas são implementações conhecidas da OpenAPI3. 0.
Podemos ver que há uma série de ferramentas que foram configuradas em diferentes programas disponíveis.
Essa lista está sempre crescendo. Recomendo enfaticamente que dê uma olhada nisso e há diferentes tecnologias
disponíveis.
Sou principalmente um desenvolvedor Java, então você pode ver várias ferramentas Java lá.
Eu mal sei soletrar Ruby, mas existem ferramentas Ruby, Node. js, Typescript, PHP. Portanto, temos um grande número de
ferramentas disponíveis.
Lembre-se de que eu disse que usaremos o editor do SwaggerHub.
Aqui estão algumas ferramentas específicas para trabalhar com a OpenAPI.
Alguns editores específicos. Muitas pessoas gostam do Visual Studio.
Na verdade, usei esta aqui no topo da extensão do Visual Studio Code, que é muito boa. Portanto, você pode preferir usar o Sisual
Studio.
É uma ferramenta gratuita que é um editorial que você pode usar.
Na verdade, sei de alguns que não estão disponíveis aqui, portanto, essa não é uma lista completa de forma alguma;
há ferramentas adicionais que não estão nessa lista.
Em seguida, você pode ver aqui as Interfaces do usuário.
Portanto, essas são ferramentas que usaremos na especificação OpenAPI e forneceremos a você a documentação.
Portanto, já vimos o swagger-ui em ação.
E aqui estão algumas opções adicionais.
Então, Widdershins é bastante popular.
Quanto à geração de documentação para o usuário final a partir da sua especificação OpenAPI, gosto bastante do
Redoc.
Essa é uma ferramenta muito boa para gerar e documentar o usuário a partir da sua especificação OpenAPI e agora você também
pode ver que temos implementações de servidor, implementações de cliente e geradores de código.
Portanto, há vários geradores de código diferentes que você pode utilizar com a especificação OpenAPI.
Vamos voltar para cá.
E lembre-se de que eu disse que a especificação da OpenAPI é respaldada por um esquema formal.
Aqui está o esquema JSON.
Se você quiser ver exatamente, é aqui que você
pode realmente dar uma olhada em como o esquema OpenAPI é definido, este é o código-fonte bruto para isso, por assim dizer, mas vamos analisar
isso por meio de uma abordagem diferente. Não vou me aprofundar muito nesse
assunto, ele volta para cá e, por fim, recomendo que você leia a documentação, pois há muita
documentação sobre isso.
Você pode ver a participação de ferramentas e bibliotecas, como é licenciado, se quiser contribuir com esse projeto,
pois é um projeto de código aberto.
Eles têm até mesmo um comitê técnico de direção que desenvolve diretrizes, então, obviamente, não vou analisar
cada uma das coisas que estamos falando para tentar chegar à OpenAPI, e você pode ver aqui que estamos
atualmente na 3. 0. 2.
E se eu clicar aqui, esse link me levará a duas versões.
Então, vou clicar aqui.
Esta é a documentação do esquema OpenAPI, com o qual vamos nos familiarizar bastante.
Especificamente, vamos analisar o desenvolvimento em relação ao esquema OpenAPI
e analisaremos o objeto específico, como o OpenAPI. Você pode ver aqui que essa é a especificação de esquema de nível superior,
que será abordada nos próximos vídeos.
Essa documentação da OpenAPI é muito rica e detalhada, e você deve considerá-la como a única fonte
da verdade quando estiver trabalhando com a documentação da OpenAPI.