docs: add API Docs

This commit is contained in:
ccbikai 2024-06-12 20:28:23 +08:00
parent 9355ff5503
commit 686ecd151a
4 changed files with 23 additions and 17 deletions

View file

@ -1 +1 @@
v20.11
v20

View file

@ -73,6 +73,10 @@ We welcome your contributions and PRs.
[Configuration Docs](./docs/configuration.md)
## 🔌 API
[API Docs](./docs/api.md)
## 🙋🏻 FAQs
[FAQs](./docs/faqs.md)

View file

@ -1,6 +1,8 @@
# Sink API
Sink has a basic API implementation but it is not stable written yet.
Writing API documentation manually can be very laborious, and we will automatically generate documents after the official release of [Nitro's OpenAPI](https://nitro.unjs.io/config#openapi).
This place provides an example of creating a short link API. Other APIs are currently available for viewing through browser developer tools.
## API Reference
@ -15,15 +17,15 @@ Sink has a basic API implementation but it is not stable written yet.
| `authorization` | `Bearer SinkCool` |
| `content-type` | `application/json` |
#### Example
```http
POST /api/link/create
HEADER authorization:Bearer SinkCool, content-type:application/json
BODY {
"url": "https://github.com/ccbikai/Sink/issues/14",
"slug": issue14
HEADER authorization: Bearer SinkCool
HEADER content-type: application/json
BODY {
"url": "https://github.com/ccbikai/Sink/issues/14",
"slug": "issue14"
}
```
@ -31,14 +33,14 @@ The BODY data must be JSON.
```http
RESPONSE 201
BODY {
"link": {
"id": "xpqhaurv5q",
"url": "https://github.com/ccbikai/Sink/issues/14",
slug": "issue14",
"createdAt": 1718119809,
"updatedAt": 1718119809
}
BODY {
"link": {
"id": "xpqhaurv5q",
"url": "https://github.com/ccbikai/Sink/issues/14",
"slug": "issue14",
"createdAt": 1718119809,
"updatedAt": 1718119809
}
}
```
@ -48,4 +50,4 @@ The BODY data must be JSON.
| `url` | `string` | This is confirmation of the submitted URL and is required. |
| `slug` | `string` | This is slug generated by the system, either automatically or from the input (if provided) |
| `createdAt` | `timestamp` | This is automatically generated with a UNIX Timestamp. |
| `updatedAt` | `timestamp` | This is automatically generated with a UNIX Timestamp. |
| `updatedAt` | `timestamp` | This is automatically generated with a UNIX Timestamp. |

View file

@ -18,7 +18,7 @@
"lint-staged": "lint-staged"
},
"engines": {
"node": ">=20.11.0"
"node": ">=20"
},
"dependencies": {
"@unovis/ts": "^1.4.1",