P
P
Pavell892020-05-03 13:11:17
API
Pavell89, 2020-05-03 13:11:17

How to generate a list of requests for the API implementation on the backend?

There is a ready-made design of the mobile application of the online store.
The backend developer asks to prepare requests for him in order for him to implement the API on the existing web store of the application day.

Tell me, how best to organize this and in what form? Where to begin?
Should the developer of the application do this?

Answer the question

In order to leave comments, you need to log in

3 answer(s)
X
xmoonlight, 2020-05-03
@Pavell89

Make a table:
1. API function call URL
2. Purpose
3. Call method
4. Request parameters
5. Response codes
6. Examples of responses with a successful outcome
7. Examples of responses with errors
This should be done by the developer (architect) of the application.
Backendschik - only checks and corrects.
Both - agree on communication between the server and the application between themselves.

I
Ivan Shumov, 2020-05-03
@inoise

This should be done by a person who leads the team and knows both parts of the system. If this is not the case, then we should sit down together and discuss it. The result of such work, as a rule, is an OpenAPI (Swagger) document. You can directly on their website and sketch

V
Vladimir Korotenko, 2020-05-03
@firedragon

The design does not make requests to the api.
But I will try to help you.
Write a list of pages. Under each screen, describe the actions,
Login
/api/signin - post
email
password
/api/register - post
email
password
List of shots
/api/shots - get
the list of shots, with the fields place, duration of the series, number in the series, notes
/api/shots /num - get shot
detail
/api/shots/num - del
delete
/api/shots - post
create Shoot
record
Settings
/api/settings - get
windowSize - integer
safeWindow - integer
multiply - float

Didn't find what you were looking for?

Ask your question

Ask a Question

731 491 924 answers to any question