58 lines
1.3 KiB
YAML
58 lines
1.3 KiB
YAML
basePath: /api/v1/
|
|
consumes:
|
|
- application/json
|
|
info:
|
|
contact:
|
|
email: alex@roese.dev
|
|
name: Alex
|
|
description: |-
|
|
Example Swagger spec.
|
|
|
|
Schemes: [http, https]
|
|
title: App-Idea Rest-API Documentation
|
|
version: 0.0.1
|
|
paths:
|
|
/users:
|
|
post:
|
|
operationId: usersNewUser
|
|
parameters:
|
|
- description: username of the user (length 3-30)
|
|
in: query
|
|
name: username
|
|
required: true
|
|
type: string
|
|
- description: email of the user (length max 200)
|
|
in: query
|
|
name: email
|
|
required: true
|
|
type: string
|
|
- description: password of the user (length 6-250)
|
|
in: query
|
|
name: password
|
|
required: true
|
|
type: string
|
|
- description: hashtag of the client (length 1-6, UPPERCASE)
|
|
in: query
|
|
name: hashtag
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"201":
|
|
description: user created
|
|
"400":
|
|
description: format is not correct
|
|
"422":
|
|
description: username or/and email already already assigned
|
|
summary: Create new user
|
|
tags:
|
|
- user
|
|
produces:
|
|
- application/json
|
|
securityDefinitions:
|
|
api_key:
|
|
in: header
|
|
name: Authorization
|
|
type: apiKey
|
|
swagger: "2.0"
|