@idelic/safety-suite-api v58.1.6
Idelic Safety Suite API
This API is to help JavaScript applications run api calls against Idelic's servers.
To create a new API:
All APIs must mirror the server they come from exactly. This includes:
- the folder structure relative to the URL
- the TypeScript types relative to the request / response bodies and query params
No logic can be run inside the API functions, they are simply to translate from JavaScript / Immutable types to the format that the server expects.
- Identify folder / file to create API in (based on the URL)
- Create required request body, response body, and query param types
- Create function signatures for normal and Immutable objects
- Make the last argument of each API call
apiOptions: ApiOptions = {}
- Setup Immutable transformers to run based on
apiOptions.useImmutable
- Build API object and call
runApi
with it - Ensure the method, url root, route and request options are all correct
- Pass through the apiOptions as is
- For every new folder, add an
index.ts
for exporting in it - For every new file, add an
export * from './fileName.ts'
in its siblingindex.ts
To identify the correct folder:
Look for patterns in the URL and put grouped APIs together based on those patterns.
Eg, the following would all go in the src/api/notifications.ts
file.
GET /api/1.0/notifications
GET /api/1.0/notifications/<id>
POST /api/1.0/notifications
...etc
Eg, the following would all go in the src/api/models/documents.ts
file.
GET /api/models/<modelId>/documents
GET /api/models/documemnts/<documentId>/content
POST /api/models/<modelId>/documents
PUT /api/models/documents
If in doubt, ask in the PR! Or take a look through the related server code to see how they structured it.
2 months ago
4 months ago
4 months ago
4 months ago
9 months ago
9 months ago
9 months ago
8 months ago
7 months ago
11 months ago
10 months ago
10 months ago
11 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
3 years ago
3 years ago
3 years ago
2 years ago
2 years ago
2 years ago
2 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
4 years ago