Realizado

Documentação Api

Publicado em 01 de Outubro de 2022 dias na TI e Programação

Sobre este projeto

Aberto

Escrever documentação para api em padrão rest, usando especificações open api v.3.0 junto ao framework Redocly.
Atividades:
Listar rotas;
Listas parâmetros;
Listar métodos disponíveis para cada entidade;
Complementar e refinar a documentação original.

Contexto Geral do Projeto

O objetivo deste projeto é escrever a documentação de nossa api, esclarecendo as funcionalidades, descrevendo com detalhes cada uma das entidades e demonstrando ao usuário como utilizar a api. É Importante que você tenha experiência na escrita de documentações de API, cujo principal objetivo é apresentar um texto para usuários de todos os níveis (programadores, gerentes de projeto e sponsors). Nós esperamos que o resultado final do trabalho seja uma documentação escrita no framework que colocamos de exemplo no documento em anexo, listando as entidades que temos disponíveis, o que elas fazem e como utilizá-las.

Categoria TI e Programação
Subcategoria Outros
Tamanho do projeto Pequeño
Isso é um projeto ou uma posição de trabalho? Um projeto
Tenho, atualmente Eu tenho especificações
Disponibilidade requerida Conforme necessário

Prazo de Entrega: 30 de Agosto de 2022

Habilidades necessárias