63 lines
1.2 KiB
YAML
63 lines
1.2 KiB
YAML
basePath: /api/v1
|
|
definitions:
|
|
main.User:
|
|
properties:
|
|
email:
|
|
type: string
|
|
id:
|
|
type: integer
|
|
name:
|
|
type: string
|
|
type: object
|
|
host: localhost:8080
|
|
info:
|
|
contact: {}
|
|
description: A basic API with support for Swagger and Middleware
|
|
title: GoApi
|
|
version: "1.0"
|
|
paths:
|
|
/health:
|
|
get:
|
|
description: Check if the API is running
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
summary: Health check
|
|
tags:
|
|
- health
|
|
/users:
|
|
get:
|
|
description: Get list of all users
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
items:
|
|
$ref: '#/definitions/main.User'
|
|
type: array
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Get users
|
|
tags:
|
|
- users
|
|
securityDefinitions:
|
|
ApiKeyAuth:
|
|
in: header
|
|
name: X-API-Key
|
|
type: apiKey
|
|
swagger: "2.0"
|