Documentação de APIDocumentação técnica

Documentação de API a partir das descrições dos seus endpoints

Entrega a partir de 1 diaAjustes incluídosControle de qualidade
Pacotes
Pagamento protegidoDetalhes
  • Os ajustes previstos no pacote são gratuitos.
  • Se você não responder em 3 dias após a entrega, o trabalho é aprovado automaticamente.
Fazer pedido · US$ 39

O dinheiro fica reservado no pagamento e só é liberado quando você aprova o trabalho.

Documentação de API a partir das descrições dos seus endpoints

Exemplo de resultado

Exemplo do pacote Padrão

Conjunto de POPs: abertura e fechamento de uma pequena cafeteria

POP-02: Fechamento da cafeteria

ObjetivoDeixar a cafeteria limpa, segura e pronta para o turno da manhã
QuemO barista do fechamento; o líder de turno assina
QuandoComeçar às 17h30, porta trancada às 18h, terminar até 18h45
Você precisa deFicha de checklist do fechamento, chave do caixa, kit de limpeza, panos azuis

Antes de começar

Atenção: nunca desligue a chave geral no quadro. As geladeiras e o alarme estão no mesmo circuito.

Passos

  1. Às 17h30, vire a placa da porta para "Últimos pedidos". Quem já está dentro pode ficar até as 18h.
  2. Coloque a máquina de café no modo enxágue. Segure o botão da xícara por 5 segundos. Você deve ver: "RINSE" piscando no visor e água quente saindo pelos dois grupos por cerca de 2 minutos.
  3. Retire os porta-filtros e deixe de molho no recipiente preto com uma pastilha de limpeza, por 20 minutos.
  4. Leve bolos e sanduíches para a geladeira dos fundos. Etiquete tudo o que foi aberto hoje com a data e "Consumir até amanhã".
  5. Anote as temperaturas das geladeiras na ficha de registro. Você deve ver: entre 1 °C e 5 °C. Se alguma passar de 5 °C, vá primeiro para o passo 12.
  6. Às 18h, tranque a porta da frente e vire a placa para "Fechado".
  7. Feche o caixa. Aperte MENU, depois "Fim do dia" e "Relatório Z". Você deve ver: o relatório sendo impresso com o total do dia. Não conte o dinheiro no balcão; leve a gaveta para o escritório.

(Passos 8 a 14: piso, lixo, alarme e bilhete de passagem de turno.)

Se algo der errado

ProblemaO que fazer
Geladeira acima de 5 °CPasse a comida para a segunda geladeira, anote horário e temperatura, avise o líder de turno
O relatório Z não imprimeTroque a bobina; se continuar, anote o total da tela e tire uma foto
O alarme não armaConfira se a porta dos fundos está bem fechada; com ela aberta, o alarme não arma

Assinatura

Barista do fechamento: nome, horário. Líder de turno: rubrica.

Última revisão: [data]. Revisar de novo quando a máquina de café ou o caixa forem trocados.

Cliente: Café Campânula, 22 lugares, 7 funcionários em turnos alternados Material: áudios da dona, um checklist escrito à mão e 9 fotos do balcão, da máquina de café e da tela do caixa Entregue: 6 procedimentos operacionais padrão (4.600 palavras): abertura, fechamento, controle do caixa, registro de temperatura das geladeiras, limpeza profunda da máquina de café e atendimento a reclamações. Abaixo, um trecho do fechamento.

O cliente e todos os dados são fictícios.

Sobre este serviço

Os desenvolvedores julgam uma API pela documentação em minutos: se a autenticação ou a primeira requisição não funcionar, eles vão embora. Escrevemos a referência e os guias da API a partir das descrições dos seus endpoints, do arquivo OpenAPI ou de exemplos de código: autenticação, URLs base, cada endpoint com parâmetros, exemplos de requisição e resposta, códigos de erro, limites de requisições e paginação. Um início rápido mostra a primeira chamada bem-sucedida em poucos passos.

O que está incluído

  • O que você recebeDocumentação da API em Markdown com blocos de código, pronta para ReadMe, GitBook, Docusaurus ou o seu repositório. Escrevemos a partir do que você envia e não chamamos a sua API.
  • Início rápidoDa chave de API à primeira chamada
  • Referência dos endpointsParâmetros, tipos, exemplos
  • Erros e limitesCódigos, significados, orientações para novas tentativas
  • Exemplos de códigocURL mais uma linguagem que você escolher
  • Termos consistentesOs mesmos nomes do seu schema

Como funciona

  1. 1
    BriefingVocê cola ou anexa endpoints e exemplos
  2. 2
    Estrutura e redaçãoEscrevemos a referência e os guias
  3. 3
    EntregaVocê recebe o Markdown pronto para publicar

O que precisamos de você

Descrições dos endpoints ou um arquivo OpenAPI ou Postman colado como texto, detalhes da autenticação, exemplos de requisições e respostas, códigos de erro e quem usa a sua API.

Vamos perguntar:

  • O que a API faz e quem a usa?
  • Como funciona a autenticação?
  • Qual linguagem os exemplos de código devem usar além de cURL?
  • Onde a documentação será publicada?

Compare os pacotes

PacotesBásicoInício rápido e até 5 endpointsUS$ 19PadrãoAté 20 endpoints com guiasUS$ 39PremiumAté 50 endpoints, documentação completaUS$ 79
Prazo1 dia3 dias5 dias
Ajustes123
Tamanhoaté 2.000 palavrasaté 6.000 palavrasaté 14.000 palavras
Endpointsaté 5até 20até 50
Linguagens dos exemplos de códigocURLcURL + 1cURL + 2
Fazer pedido BásicoFazer pedido PadrãoFazer pedido Premium

Pagamento protegido

Você paga ao fazer o pedido, mas o dinheiro só é liberado pelo trabalho aprovado.

  • Preço fixoO preço do pacote não muda depois que você paga.
  • O dinheiro fica reservadoAo pagar, o valor fica apenas reservado. Ele só é repassado quando você aprova o trabalho.
  • Verificado antes da entregaCada resultado passa por um controle de qualidade antes de chegar até você, e você o vê na página do pedido antes de aprovar.
  • Ajustes gratuitosPeça ajustes dentro do seu briefing quantas vezes o pacote permitir.
  • Aprovação após 3 diasSe em 3 dias após a entrega você não aprovar o trabalho nem pedir ajustes, ele é aprovado automaticamente. Se você escrever no chat do pedido após a entrega, o pedido fica em espera; depois que respondermos, podemos reiniciar a contagem de 3 dias e avisaremos no chat.
  • Refazer ou reembolso totalSe o resultado não corresponder ao seu briefing e os ajustes não resolverem, ou se o trabalho levar mais que o dobro do prazo, escreva no chat do pedido: refazemos o trabalho ou reembolsamos o pagamento integralmente.
Como funciona →

Perguntas e respostas

Vocês podem trabalhar a partir da nossa especificação OpenAPI?

Sim, cole o YAML ou JSON no briefing. Transformamos as descrições em páginas de referência legíveis e preenchemos as lacunas que você apontar.

Vocês vão testar os exemplos?

Não chamamos a sua API. Os exemplos são montados a partir das suas amostras de requisição e resposta, então execute-os uma vez antes de publicar.

Vocês escrevem documentação de SDK?

Sim, se você enviar as assinaturas dos métodos e exemplos de uso. Cada SDK conta como parte do volume do pacote.

Pacotes
Fazer pedido · US$ 39· 3 dias