immich-app/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2025-12-19 01:11:07 +03:00
Code Issues Packages Projects Releases 17 Wiki Activity

docs: update contributing pages (#2503)

Browse Source
This commit is contained in:
Jason Rasmussen
2023-05-20 21:46:09 -04:00
committed by GitHub
parent 3d426b55d3
commit f984be8ea0
7 changed files with 37 additions and 84 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/docs/developer/open-api.md
View File

@@ -1,7 +1,17 @@
---
sidebar_position: 5
---
# Open API
Immich uses the [Open API](https://swagger.io/specification/) standard to generate API documentation. To view the published docs see [here](/docs/api).
## Generator
OpenAPI is used to generate the client (Typescript, Dart) SDK. `openapi-generator-cli` can be installed [here](https://openapi-generator.tech/docs/installation/). When you add a new or modify an existing endpoint, you must run the command below to update the client SDK.
```bash
npm run api:generate # Run from the `server/` directory
```
You can find the generated client SDK in the `web/src/api` for Typescript SDK and `mobile/openapi` for Dart SDK.
:::tip
This can also be run via `make api` from the project root directory (not in the `server` folder)
:::