356 lines
12 KiB
JSON
356 lines
12 KiB
JSON
{
|
|
"swagger": "2.0",
|
|
"info": {
|
|
"description": "A simple Contacts CRUD API",
|
|
"title": "Contacts API",
|
|
"termsOfService": "http://swagger.io/terms/",
|
|
"contact": {
|
|
"name": "API Support",
|
|
"email": "gabriel.delosrios@tutamail.com"
|
|
},
|
|
"license": {
|
|
"name": "MIT",
|
|
"url": "https://opensource.org/licenses/MIT"
|
|
},
|
|
"version": "1.0"
|
|
},
|
|
"host": "agenda-web-go.gabilandia.com",
|
|
"basePath": "/",
|
|
"paths": {
|
|
"/contacts": {
|
|
"get": {
|
|
"description": "Get a list of all contacts",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"tags": [
|
|
"contacts"
|
|
],
|
|
"summary": "Get all contacts",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/handler.APIResponse"
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/models.Contact"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/handler.APIResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"description": "Create a new contact with the provided data",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"tags": [
|
|
"contacts"
|
|
],
|
|
"summary": "Create a new contact",
|
|
"parameters": [
|
|
{
|
|
"description": "Contact object",
|
|
"name": "contact",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/models.Contact"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"schema": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/handler.APIResponse"
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/definitions/models.Contact"
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/handler.APIResponse"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/handler.APIResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/contacts/{id}": {
|
|
"get": {
|
|
"description": "Get a single contact by its ID",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"tags": [
|
|
"contacts"
|
|
],
|
|
"summary": "Get a contact by ID",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Contact ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/handler.APIResponse"
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"$ref": "#/definitions/models.Contact"
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/handler.APIResponse"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"$ref": "#/definitions/handler.APIResponse"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/handler.APIResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"description": "Update an existing contact by ID",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"tags": [
|
|
"contacts"
|
|
],
|
|
"summary": "Update a contact",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Contact ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
},
|
|
{
|
|
"description": "Contact object",
|
|
"name": "contact",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/models.Contact"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/handler.APIResponse"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/handler.APIResponse"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"$ref": "#/definitions/handler.APIResponse"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/handler.APIResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"description": "Delete a contact by ID",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"tags": [
|
|
"contacts"
|
|
],
|
|
"summary": "Delete a contact",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Contact ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/handler.APIResponse"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/handler.APIResponse"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"$ref": "#/definitions/handler.APIResponse"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/handler.APIResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"definitions": {
|
|
"handler.APIError": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"description": "Error code",
|
|
"type": "integer"
|
|
},
|
|
"details": {
|
|
"description": "Additional error details",
|
|
"type": "string"
|
|
},
|
|
"field": {
|
|
"description": "Field name if applicable",
|
|
"type": "string",
|
|
"example": "name"
|
|
},
|
|
"message": {
|
|
"description": "Human-readable error message",
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"handler.APIResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"description": "The response data"
|
|
},
|
|
"errors": {
|
|
"description": "List of errors if any occurred",
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/handler.APIError"
|
|
}
|
|
},
|
|
"message": {
|
|
"description": "Optional message",
|
|
"type": "string"
|
|
},
|
|
"success": {
|
|
"description": "Indicates if the request was successful",
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"models.Contact": {
|
|
"type": "object",
|
|
"properties": {
|
|
"company": {
|
|
"description": "Company the contact works for",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"description": "ID is the unique identifier for the contact",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Name of the contact",
|
|
"type": "string"
|
|
},
|
|
"phone": {
|
|
"description": "Phone number in international format",
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
} |