Completed

Documentação Api

Published on the October 01, 2022 in IT & Programming

About this project

Open

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.

Project overview

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.

Category IT & Programming
Subcategory Other
Project size Small
Is this a project or a position? Project
I currently have I have specifications
Required availability As needed

Delivery term: August 30, 2022

Skills needed