pejhancctv/docs/swagger.yaml

78 lines
1.6 KiB
YAML

definitions:
models.User:
properties:
birthDay:
type: string
created_at:
type: string
email:
type: string
first_name:
type: string
is_removed:
type: boolean
last_name:
type: string
national_code:
type: string
password:
type: string
postCode:
type: string
removed_at:
type: string
role:
type: string
updated_at:
type: string
user_id:
type: integer
username:
type: string
type: object
externalDocs:
description: OpenAPI
url: https://swagger.io/resources/open-api/
host: localhost:8000
info:
contact:
email: support@swagger.io
name: API Support
url: http://www.swagger.io/support
description: This is a sample server celler server.
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
termsOfService: http://swagger.io/terms/
title: Swagger Example API
version: "1.0"
paths:
/users/:
post:
consumes:
- application/json
description: Send UserModel
parameters:
- description: User Model
in: body
name: user
required: true
schema:
$ref: '#/definitions/models.User'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.User'
"400":
description: Bad Request
summary: Register User
tags:
- register
securityDefinitions:
BasicAuth:
type: basic
swagger: "2.0"