Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nglmq authored Oct 24, 2024
1 parent 6a62d63 commit 8c62bcf
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,14 @@
- CONFIG

## URLs
```POST / ``` - short url
```POST /api/shorten``` - request body ```{"url":"<some_url>"}``` => result ```{"result":"<short_url>"}```
```POST /api/shorten/batch``` - req body ```[{"correlation_id": "<строковый идентификатор>", "original_url": "<URL для сокращения>"},...]``` => ```[{"correlation_id": "<строковый идентификатор из объекта запроса>", "short_url": "<результирующий сокращённый URL>"},...]```
```GET /{id}``` - normal url
```GET /ping``` - check db connecction
```GET /api/user/urls``` - all users short urls. Only authorized users.
```GET /api/internal/stats``` - quantity of users and short urls
```DELETE /api/user/urls``` - soft delete

```POST / ``` - short url
```POST /api/shorten``` - request body ```{"url":"<some_url>"}``` => result ```{"result":"<short_url>"}```
```POST /api/shorten/batch``` - req body ```[{"correlation_id": "<строковый идентификатор>", "original_url": "<URL для сокращения>"},...]``` => ```[{"correlation_id": "<строковый идентификатор из объекта запроса>", "short_url": "<результирующий сокращённый URL>"},...]```
```GET /{id}``` - normal url
```GET /ping``` - check db connecction
```GET /api/user/urls``` - all users short urls. Only authorized users.
```GET /api/internal/stats``` - quantity of users and short urls
```DELETE /api/user/urls``` - soft delete
gRPC сервер полностью дублирует HTTP хендлеры. Используется middleware для gzip шифрования. Также используются JWT токены для авторизации.

0 comments on commit 8c62bcf

Please sign in to comment.