Nhazi API

Anyị nwere ike inyere gị aka ịhazi ụzọ RESTful API maka ngwa weebụ gị.
A na-agbaso otu usoro ndị ahụ e depụtara n'usoro mmepe ngwanrọ anyị—nke gụnyere nhazi atụmatụ, imewe, mmejuputa, nnwale, na itinye ya n'ọrụ—mgbe a na-emepụta ụzọ API gị.
Ịhazi
Ihe anyị na-atụle n'aka gị n'oge usoro nhazi
- A na-atụle na ị ga-ewepụta oge ruru awa abụọ kachasị n'oge ehihie gị maka nzukọ a.
- A na-akwado akwụkwọ nkọwa ihe ndị dị mkpa dabere na ozi ị nyere. A na-atụle na ị ga-eme ihe ndị a:
- Mara ndị na-eji usoro gị: Ndị nchịkwa, ndị ọbịa, wdg.
- Mara ihe ndị ọrụ gị nwere ike iji API gị mee:
- Mepụta, gụọ, melite ma ọ bụ hichapụ ozi dị na ngwa weebụ gị.
- Mara ka ndị ọrụ gị si enweta API gị:
- Iziga arịrịọ POST, GET, PUT na DELETE na ngwa weebụ gị.
Ihe ị ga-atụle n'aka anyị n'oge usoro nhazi
- Akwụkwọ nkọwa ihe achọrọ maka API nke emechara nhazi ya dabere na ozi ị nyere.
- A ghaghị ịkwado akwụkwọ ahụ dị n'elu tupu e bido ọrụ nhazi ya.
Nhazi na Mmejuputa
- A na-ede akwụkwọ OpenAPI dabere na ihe ndị ị chọrọ.
- E nyere ihe atụ nke faịlụ .yaml n'okpuru ebe a:
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.- Anyị nwekwara ike ilekọta etu a ga-esi tinye faịlụ YAML a kpọtụrụ aha n'elu n'ime usoro backend gị. A ga-akwụ ụgwọ gị dabere na ọnụego a na-anabatakarị maka ọrụ mmepe backend.
Nnwale na Mmejuputa
- Anyị na-elekọta ule API gị, a na-enyekwa gị ndepụta nke ule ndị ahụ e dere ede.
- A na-ezitere gị API ahụ a rụchara arụcha n'ime ebe nchekwa git.
Ọnụego
| Ọrụ | Ọnụego kwa awa |
|---|---|
| HTTP API Design | 125 000 FC/hour |
| Back-end development | 125 000 FC/hour |