Descrição do projeto
TraduzidoNossa API REST cresceu para mais de quarenta endpoints, e nenhum deles está documentado hoje. Desenvolvedores que se integram conosco essencialmente reengenheiram a lógica da API a partir de exemplos de solicitação — isso desacelera as coisas e cria uma enxurrada de perguntas de suporte. Queremos resolver esse problema de forma completa e encomendar uma especificação completa do OpenAPI 3.0 junto com um portal do desenvolvedor polido onde a documentação possa ser lida e testada ao vivo.
Precisamos de um executor que combine uma forte escrita técnica com experiência real em API, porque a tarefa é igualmente sobre explicação clara e esquemas precisos. Precisamos preparar uma especificação completa em YAML do OpenAPI 3.0 para todos os endpoints — com esquemas de solicitação e resposta e códigos de erro — e então transformá-la em documentação interativa no Swagger UI ou Redoc. Além da referência, precisamos de um guia de Introdução cobrindo autenticação, limites de taxa, paginação e tratamento de erros, além de exemplos de código prontos em cURL, PHP e JavaScript para cada endpoint chave. Uma coleção do Postman e um modelo de changelog completam o quadro.
Fornecemos acesso à API, documentação interna de código e uma lista completa de endpoints; esperamos a documentação finalizada em 21 dias.
Resultado:
— 1. Especificação YAML do OpenAPI 3.0 — todos os endpoints, esquemas de solicitação/resposta, códigos de erro
— 2. Documentação interativa (Swagger UI ou Redoc)
— 3. Introdução — autenticação, limites, paginação, erros
— 4. Exemplos de código — cURL, PHP, JS para cada endpoint chave
— 5. Modelo de changelog
— 6. Coleção do Postman
Processo:
— Fornecemos: acesso à API, documentação de código, lista de endpoints
— Você: documentação completa em 21 dias
Precisamos de um executor que combine uma forte escrita técnica com experiência real em API, porque a tarefa é igualmente sobre explicação clara e esquemas precisos. Precisamos preparar uma especificação completa em YAML do OpenAPI 3.0 para todos os endpoints — com esquemas de solicitação e resposta e códigos de erro — e então transformá-la em documentação interativa no Swagger UI ou Redoc. Além da referência, precisamos de um guia de Introdução cobrindo autenticação, limites de taxa, paginação e tratamento de erros, além de exemplos de código prontos em cURL, PHP e JavaScript para cada endpoint chave. Uma coleção do Postman e um modelo de changelog completam o quadro.
Fornecemos acesso à API, documentação interna de código e uma lista completa de endpoints; esperamos a documentação finalizada em 21 dias.
Resultado:
— 1. Especificação YAML do OpenAPI 3.0 — todos os endpoints, esquemas de solicitação/resposta, códigos de erro
— 2. Documentação interativa (Swagger UI ou Redoc)
— 3. Introdução — autenticação, limites, paginação, erros
— 4. Exemplos de código — cURL, PHP, JS para cada endpoint chave
— 5. Modelo de changelog
— 6. Coleção do Postman
Processo:
— Fornecemos: acesso à API, documentação de código, lista de endpoints
— Você: documentação completa em 21 dias
Textos e tradução Dinheiro, Transferência bancária
