Terminado

Documentação Api

Publicado el 01 Octubre, 2022 en Programación y Tecnología

Sobre este proyecto

Abierto

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 general del proyecto

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.

Categoría Programación y Tecnología
Subcategoría Otros
Tamaño del proyecto Pequeño
¿Es un proyecto o una posición? Un proyecto
Actualmente tengo Tengo las especificaciones
Disponibilidad requerida Según se necesite

Plazo de Entrega: 30 Agosto, 2022

Habilidades necesarias