Usanifu wa API

Tunaweza kukusaidia kubuni njia za RESTful API kwa ajili ya programu yako ya wavuti.

Hatua zilezile zilizoainishwa katika mzunguko wetu wa maisha ya uundaji wa programu—yaani Upangaji, Usanifu, Utekelezaji, Upimaji na Uwekaji katika matumizi—hufuatwa pia wakati wa kuunda njia (routes) za API yako.

Upangaji

Tunachotarajia kutoka kwako katika hatua ya upangaji

1. Unatarajiwa kutenga muda usiozidi saa mbili wakati wa mchana kwa ajili ya mkutano huu.
2. Hati ya mahitaji huandaliwa kulingana na taarifa unazotoa. Unatarajiwa:
   • Tambua watumiaji wako ni akina nani: Wasimamizi, Wageni, n.k.
   • Elewa kile ambacho watumiaji wako wanaweza kufanya kwa kutumia API yako:
     • Tengeneza, soma, sasisha au futa taarifa kwenye programu yako ya wavuti.
   • Elewa jinsi watumiaji wako wanavyoweza kufikia API yako:
     • Kutuma maombi ya POST, GET, PUT na DELETE kwenye programu yako ya wavuti.

Mambo unayoweza kutarajia kutoka kwetu wakati wa hatua ya upangaji

1. Hati ya mwisho ya mahitaji ya API iliyoandaliwa kulingana na taarifa unazotoa.
2. Hati hiyo hapo juu lazima iidhinishwe kabla ya kuendelea na hatua ya usanifu.

Usanifu na Utekelezaji

1. Hati ya OpenAPI huandaliwa kulingana na mahitaji yako.
2. Mfano wa faili ya .yaml umetolewa hapa chini:

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.

• Tunaweza pia kushughulikia utekelezaji wa faili hiyo ya YAML katika mfumo wako wa 'backend'. Utatozwa kulingana na viwango vya kawaida vya uundaji wa 'backend'.

Upimaji na Utekelezaji

• Tunashughulikia majaribio yako ya API na unapewa orodha ya majaribio yaliyoandaliwa.
• API iliyokamilishwa hutumwa kwako katika hazina ya Git.

Viwango

Huduma	Kiwango cha saa
HTTP API Design
Back-end development

Je, uko tayari kuagiza?

• Wasiliana Nasi