Design de API

Podemos ajudar você a projetar rotas de API RESTful para sua aplicação web.

As mesmas etapas descritas em nosso ciclo de vida de desenvolvimento de software — planejamento, design, implementação, testes e implantação — também são seguidas durante o desenvolvimento das rotas da sua API.

Planejamento

O que esperamos de você durante a fase de Planejamento

1. Espera-se que você reserve, no máximo, 2 horas do seu horário de expediente para esta reunião.
2. O documento de requisitos é elaborado com base nas informações fornecidas por você. Espera-se que você:
   • Saiba quem são seus usuários: Administradores, Convidados, etc.
   • Saiba o que seus usuários podem fazer com sua API:
     • Criar, ler, atualizar ou excluir informações na sua aplicação web.
   • Saiba como seus usuários podem acessar sua API:
     • Enviando requisições POST, GET, PUT e DELETE para sua aplicação web.

O que esperar de nós durante a fase de planejamento

1. Um documento finalizado de requisitos da API, elaborado com base nas informações fornecidas por você.
2. O documento mencionado acima deve ser aprovado antes de prosseguirmos para a fase de design.

Design e implementação

1. Um documento OpenAPI é elaborado com base nos seus requisitos.
2. Um exemplo de arquivo .yaml é apresentado abaixo:

openapi: '3.1.0'
info:
  version: '1.0.0'
  title: 'Sample API'
  description: Sample API for the recipes and restaurants

servers:
  - url: https://stuntbusiness.cdapi

paths:
      
  /recipe:
    get:
      security: 
          - bearerAuth: [] 
      summary: Get the list of recipes
      operationId: getAllRecipes
      responses:
        200:
          description: The array of recipes 
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Recipes"
        500:
          description: Unexpected error 
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"

    # Other paths here.

• Também podemos realizar a implementação do arquivo YAML mencionado no seu backend. Serão aplicadas as tarifas padrão de desenvolvimento de backend.

Testes e Implantação

• Realizamos os testes da sua API e fornecemos uma lista dos testes executados.
• A API finalizada é entregue em um repositório Git.

Tarifas

Serviços	Tarifa por hora
Design de API HTTP	125.000 FC/hora
Desenvolvimento back-end	125.000 FC/hora

Pronto para fazer o pedido?

• Contact Us