Descrição do projeto
TraduzidoNossa API REST cresceu para mais de quarenta endpoints e, neste momento, nenhum deles está documentado. Os desenvolvedores que estão integrando conosco estão efetivamente fazendo engenharia reversa da API a partir de solicitações de exemplo, o que atrasa todos e gera um fluxo constante de perguntas de suporte evitáveis. Queremos corrigir isso adequadamente, encomendando uma especificação completa OpenAPI 3.0 juntamente com um portal de desenvolvedor polido que as pessoas possam realmente ler e experimentar.
Estamos procurando alguém que combine forte redação técnica com experiência prática real em API, porque este trabalho é tanto sobre explicação clara quanto sobre esquemas precisos. Você produzirá uma especificação completa OpenAPI 3.0 em YAML cobrindo cada endpoint, seus esquemas de solicitação e resposta e seus códigos de erro, e então transformará isso em documentos interativos hospedados com Swagger UI ou Redoc. Além da referência, precisamos de um guia de Introdução que passe pela autenticação, limites de taxa, paginação e tratamento de erros, além de exemplos de código para copiar e colar em cURL, PHP e JavaScript para cada endpoint principal. Complete com uma coleção do Postman e um modelo de changelog para histórico de versões.
Forneceremos acesso à API, nossos documentos de código interno existentes e a lista completa de endpoints; esperamos a documentação finalizada dentro de vinte e um dias.
Entregáveis:
— 1. Especificação OpenAPI 3.0 em YAML — todos os endpoints, esquemas de solicitação/resposta, códigos de erro
— 2. Documentos interativos da API — página hospedada no Swagger UI ou Redoc
— 3. Guia de Introdução — autenticação, limites de taxa, paginação, erros
— 4. Exemplos de código — cURL, PHP, JavaScript para cada endpoint principal
— 5. Changelog — modelo de histórico de versões
— 6. Exportação da coleção do Postman
Processo:
— Nós fornecemos: acesso à API, documentos da base de código existente, lista de endpoints
— Você entrega: documentação completa em 21 dias
— Redação técnica forte mais experiência em API necessária
Estamos procurando alguém que combine forte redação técnica com experiência prática real em API, porque este trabalho é tanto sobre explicação clara quanto sobre esquemas precisos. Você produzirá uma especificação completa OpenAPI 3.0 em YAML cobrindo cada endpoint, seus esquemas de solicitação e resposta e seus códigos de erro, e então transformará isso em documentos interativos hospedados com Swagger UI ou Redoc. Além da referência, precisamos de um guia de Introdução que passe pela autenticação, limites de taxa, paginação e tratamento de erros, além de exemplos de código para copiar e colar em cURL, PHP e JavaScript para cada endpoint principal. Complete com uma coleção do Postman e um modelo de changelog para histórico de versões.
Forneceremos acesso à API, nossos documentos de código interno existentes e a lista completa de endpoints; esperamos a documentação finalizada dentro de vinte e um dias.
Entregáveis:
— 1. Especificação OpenAPI 3.0 em YAML — todos os endpoints, esquemas de solicitação/resposta, códigos de erro
— 2. Documentos interativos da API — página hospedada no Swagger UI ou Redoc
— 3. Guia de Introdução — autenticação, limites de taxa, paginação, erros
— 4. Exemplos de código — cURL, PHP, JavaScript para cada endpoint principal
— 5. Changelog — modelo de histórico de versões
— 6. Exportação da coleção do Postman
Processo:
— Nós fornecemos: acesso à API, documentos da base de código existente, lista de endpoints
— Você entrega: documentação completa em 21 dias
— Redação técnica forte mais experiência em API necessária
Textos e tradução Dinheiro, Transferência bancária
