This is a simple API for Shortener URL
Version: 1.0.0
Contact information:
syrchikov_max@mail.ru
License: Apache 2.0
BasicAuth
| basic | Basic |
|---|
Summary: User registrations
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| body | body | User registration | Yes | object |
Responses
| Code | Description |
|---|---|
| 200 | |
| 400 |
Summary: Logs user into the system
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| body | body | User email, user password | Yes | object |
Responses
| Code | Description |
|---|---|
| 200 | |
| 400 |
Summary: Logs out current logged in user session
Responses
| Code | Description |
|---|---|
| 204 | |
| 401 |
Security
| Security Schema | Scopes |
|---|---|
| BasicAuth |
Summary: Info about current user
Responses
| Code | Description |
|---|---|
| 200 | |
| 401 |
Security
| Security Schema | Scopes |
|---|---|
| BasicAuth |
Summary: Creating a new short link
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| body | body | Full link | Yes | object |
Responses
| Code | Description |
|---|---|
| 200 | |
| 400 | |
| 401 |
Security
| Security Schema | Scopes |
|---|---|
| BasicAuth |
Summary: Get all short links for this user
Responses
| Code | Description |
|---|---|
| 200 | |
| 401 |
Security
| Security Schema | Scopes |
|---|---|
| BasicAuth |
Summary: Get information about a specific short user link
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| hash | path | Hash of short url | Yes | string |
Responses
| Code | Description |
|---|---|
| 200 | |
| 400 | |
| 404 |
Security
| Security Schema | Scopes |
|---|---|
| BasicAuth |
Summary: Remove short link
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| hash | path | Hash of short url | Yes | string |
Responses
| Code | Description |
|---|---|
| 204 | |
| 401 | |
| 404 |
Security
| Security Schema | Scopes |
|---|---|
| BasicAuth |
Summary: Get top from 20 referring sites
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| hash | path | Hash of short url | Yes | string |
Responses
| Code | Description |
|---|---|
| 200 | |
| 401 | |
| 404 |
Security
| Security Schema | Scopes |
|---|---|
| BasicAuth |
Summary: Get link for redirect
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| hash | path | Hash of short url | Yes | string |
Responses
| Code | Description |
|---|---|
| 301 | |
| 404 |
| Name | Type | Description | Required |
|---|---|---|---|
| id | long | Yes | |
| username | string | Yes | |
| hash | string | Yes | |
| string | Yes | ||
| dateCreated | string | Yes | |
| timezone | string | No | |
| language | string | No |
| Name | Type | Description | Required |
|---|---|---|---|
| id | long | Yes | |
| shortUrl | string | Short url | Yes |
| fullUrl | string | Full link | Yes |
| userId | long | No | |
| clicks | long | Clicks this link | No |
| dateCreated | string (string) | No |
| Name | Type | Description | Required |
|---|---|---|---|
| id | long | Yes | |
| linkId | long | Yes | |
| referer | string | Where the transition came from | No |
| dateCreated | dateTime | No |
| Name | Type | Description | Required |
|---|---|---|---|
| code | integer | Yes | |
| message | string | No |
restapi/configure_shortener.go - файл с конфигурациями
api/handlers - хэндлеры
swagger/swagger.yml - сваггер-файл
| swagger-markdown -i ./swagger/swagger.yml - сгенерировать md-файл |
| swagger generate server -A shortener -f ./swagger/swagger.yml - сгенерировать код |