swagger.json

{
	"$schema": "https://swagger.io/specification/v2/schema.json",
	"swagger": "2.0",
	"info": {
		"version": "1.0.0",
		"title": "API Documentation",
		"description": "A generic API for managing users and spaces."
	},
	"host": "localhost:3000",
	"basePath": "/api",
	"tags": [
		{
			"name": "Users",
			"description": "Operations related to user management"
		},
		{
			"name": "Spaces",
			"description": "Endpoints for managing spaces"
		}
	],
	"schemes": ["http"],
	"consumes": ["application/json"],
	"produces": ["application/json"],
	"paths": {
		"/users": {
			"get": {
				"summary": "List all users",
				"tags": ["Users"],
				"responses": {
					"200": {
						"description": "A list of users",
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/definitions/User"
							}
						}
					}
				}
			},
			"post": {
				"summary": "Create a new user",
				"tags": ["Users"],
				"parameters": [
					{
						"name": "user",
						"in": "body",
						"description": "The user to create",
						"required": true,
						"schema": {
							"$ref": "#/definitions/User"
						}
					}
				],
				"responses": {
					"201": {
						"description": "User created successfully",
						"schema": {
							"$ref": "#/definitions/User"
						}
					}
				}
			}
		},
		"/spaces": {
			"get": {
				"summary": "List all spaces",
				"tags": ["Spaces"],
				"responses": {
					"200": {
						"description": "A list of spaces",
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/definitions/Space"
							}
						}
					}
				}
			},
			"post": {
				"summary": "Create a new space",
				"tags": ["Spaces"],
				"parameters": [
					{
						"name": "space",
						"in": "body",
						"description": "The space to create",
						"required": true,
						"schema": {
							"$ref": "#/definitions/Space"
						}
					}
				],
				"responses": {
					"201": {
						"description": "Space created successfully",
						"schema": {
							"$ref": "#/definitions/Space"
						}
					}
				}
			}
		}
	},
	"definitions": {
		"User": {
			"type": "object",
			"properties": {
				"id": {
					"type": "integer",
					"format": "int64"
				},
				"name": {
					"type": "string"
				},
				"email": {
					"type": "string"
				}
			},
			"required": ["id", "name", "email"]
		},
		"Space": {
			"type": "object",
			"properties": {
				"id": {
					"type": "integer",
					"format": "int64"
				},
				"name": {
					"type": "string"
				},
				"location": {
					"type": "string"
				}
			},
			"required": ["id", "name", "location"]
		}
	}
}