API Design

We can help you design RESTful API routes for your web application.

The same steps outlined in our Software development lifecycle, that are Planning, Design, Implementation, Testing and Deployment are also followed during the development of your API routes.

Planning

What we expect from you during the Planning phase

1. You are expected to allocate at most 2 hours of your daytime for this meeting.
2. The requirement document is established based on the information you provide. You are expected to:
   • Know who are your users: Administrators, Guests, etc
   • Know what your users can do with your API:
     • Create, Read, Update or Delete the information on your web application
   • Know how your users can access your API:
     • Sending POST, GET, PUT and DELETE requests to your web application.

What you can expect from us during the Planning phase

1. A finalized API requirement document established based on the information you provide.
2. The above document has to be approved before moving to the design.

Design and Implementation

1. An OpenAPI document is written based on your requirements
2. A sample of a .yaml file is provided below:

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

servers:
  - url: https://templates.stuntbusiness.ca/api

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.

• We can also handle the implementation of the above yaml file in your backend. You will be charged for the regular rates tied to backend development.

Testing and Deployment

• We handle your API tests and a list of the written tests is provided to you.
• The finalized API is shipped to you in a git repository.

Rates

Tables	Hourly rate
HTTP API Design	125 000 FC/hour
Back-end development	125 000 FC/hour

Ready to order?

• Contact Us