OpenAPI

You can sync GitBook pages with an OpenAPI or Swagger file or a URL to include auto-generated API methods in your documentation.

OpenAPI block

GitBook's OpenAPI block is powered by Scalar, so you can test your APIs directly from your docs.

Create a new user

POST /users

Headers

Name

Value

Content-Type

application/json

Authorization

Bearer <token>

Body

Name

Type

Description

name

string

Name of the user

age

number

Age of the user

Response

{
  "id": 1,
  "name": "John",
  "age": 30
}

post

Body

usernamestringRequired

passwordstringRequired

Responses

200

Authenticated

application/json

401

Invalid credentials

post

/auth/login

POST /api/auth/login HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "username": "text",
  "password": "text"
}

{
  "token": {
    "token": "text",
    "expiration": "2025-12-18T05:58:51.603Z"
  },
  "user": {
    "id": "text",
    "username": "text",
    "email": "text",
    "role": "text"
  }
}

Get all projects

get

Responses

200

List of projects

application/json

get

/projects

GET /api/projects HTTP/1.1
Host: 
Accept: */*

200

List of projects

[
  {
    "id": 1,
    "title": "text",
    "description": "text",
    "imageUrl": "text",
    "gitHubUrl": "text",
    "liveUrl": "text",
    "created": "2025-12-18T05:58:51.603Z",
    "technologies": [
      "text"
    ]
  }
]

Create a new project

post

Body

titlestringRequired

descriptionstringOptional

imageUrlstringOptional

gitHubUrlstringOptional

liveUrlstringOptional

technologiesstring[]Optional

Responses

201

Project created

application/json

post

/projects

POST /api/projects HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 115

{
  "title": "text",
  "description": "text",
  "imageUrl": "text",
  "gitHubUrl": "text",
  "liveUrl": "text",
  "technologies": [
    "text"
  ]
}

201

Project created

{
  "id": 1,
  "title": "text",
  "description": "text",
  "imageUrl": "text",
  "gitHubUrl": "text",
  "liveUrl": "text",
  "created": "2025-12-18T05:58:51.603Z",
  "technologies": [
    "text"
  ]
}

Get a project by ID

get

Path parameters

idintegerRequired

Responses

200

Project

application/json

404

Not found

get

/projects/{id}

GET /api/projects/{id} HTTP/1.1
Host: 
Accept: */*

{
  "id": 1,
  "title": "text",
  "description": "text",
  "imageUrl": "text",
  "gitHubUrl": "text",
  "liveUrl": "text",
  "created": "2025-12-18T05:58:51.603Z",
  "technologies": [
    "text"
  ]
}

Update a project

put

Path parameters

idintegerRequired

Body

titlestringOptional

descriptionstringOptional

imageUrlstringOptional

gitHubUrlstringOptional

liveUrlstringOptional

technologiesstring[]Optional

Responses

204

Updated

404

Not found

put

/projects/{id}

PUT /api/projects/{id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 115

{
  "title": "text",
  "description": "text",
  "imageUrl": "text",
  "gitHubUrl": "text",
  "liveUrl": "text",
  "technologies": [
    "text"
  ]
}

No content

Delete a project

delete

Path parameters

idintegerRequired

Responses

204

Deleted

404

Not found

delete

/projects/{id}

DELETE /api/projects/{id} HTTP/1.1
Host: 
Accept: */*

No content

Get all skills

get

Responses

200

List of skills

application/json

get

/skills

GET /api/skills HTTP/1.1
Host: 
Accept: */*

200

List of skills

[
  {
    "id": 1,
    "name": "text",
    "category": "text",
    "proficiencyLevel": 1,
    "iconUrl": "text"
  }
]

Create a new skill

post

Body

namestringRequired

categorystringOptional

proficiencyLevelintegerOptional

iconUrlstringOptional

Responses

201

Skill created

application/json

post

/skills

POST /api/skills HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "name": "text",
  "category": "text",
  "proficiencyLevel": 1,
  "iconUrl": "text"
}

201

Skill created

{
  "id": 1,
  "name": "text",
  "category": "text",
  "proficiencyLevel": 1,
  "iconUrl": "text"
}

Get a skill by ID

get

Path parameters

idintegerRequired

Responses

200

Skill

application/json

404

Not found

get

/skills/{id}

GET /api/skills/{id} HTTP/1.1
Host: 
Accept: */*

{
  "id": 1,
  "name": "text",
  "category": "text",
  "proficiencyLevel": 1,
  "iconUrl": "text"
}

Update a skill

put

Path parameters

idintegerRequired

Body

namestringOptional

categorystringOptional

proficiencyLevelintegerOptional

iconUrlstringOptional

Responses

204

Updated

404

Not found

put

/skills/{id}

PUT /api/skills/{id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "name": "text",
  "category": "text",
  "proficiencyLevel": 1,
  "iconUrl": "text"
}

No content

Delete a skill

delete

Path parameters

idintegerRequired

Responses

204

Deleted

404

Not found

delete

/skills/{id}

DELETE /api/skills/{id} HTTP/1.1
Host: 
Accept: */*

No content

Get all skill categories

get

Responses

200

List of categories

application/json

Responsestring[]

get

/skills/categories

GET /api/skills/categories HTTP/1.1
Host: 
Accept: */*

200

List of categories

[
  "text"
]

Get skills by category

get

Path parameters

categorystringRequired

Responses

200

List of skills

application/json

404

Not found

get

/skills/category/{category}

GET /api/skills/category/{category} HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": 1,
    "name": "text",
    "category": "text",
    "proficiencyLevel": 1,
    "iconUrl": "text"
  }
]

Submit a contact message

post

Body

namestringRequired

emailstringRequired

subjectstringOptional

messagestringRequired

Responses

201

Message submitted

application/json

post

/contact

POST /api/contact HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "name": "text",
  "email": "text",
  "subject": "text",
  "message": "text"
}

201

Message submitted

{
  "id": 1,
  "name": "text",
  "email": "text",
  "subject": "text",
  "message": "text",
  "receivedAt": "2025-12-18T05:58:51.603Z",
  "isRead": true
}

Get all contact messages

get

Responses

200

List of contact messages

application/json

get

/contact

GET /api/contact HTTP/1.1
Host: 
Accept: */*

200

List of contact messages

[
  {
    "id": 1,
    "name": "text",
    "email": "text",
    "subject": "text",
    "message": "text",
    "receivedAt": "2025-12-18T05:58:51.603Z",
    "isRead": true
  }
]

Get a contact message by ID

get

Path parameters

idintegerRequired

Responses

200

Contact message

application/json

404

Not found

get

/contact/{id}

GET /api/contact/{id} HTTP/1.1
Host: 
Accept: */*

{
  "id": 1,
  "name": "text",
  "email": "text",
  "subject": "text",
  "message": "text",
  "receivedAt": "2025-12-18T05:58:51.603Z",
  "isRead": true
}

Delete a contact message

delete

Path parameters

idintegerRequired

Responses

204

Deleted

404

Not found

delete

/contact/{id}

DELETE /api/contact/{id} HTTP/1.1
Host: 
Accept: */*

No content

PreviousInteractive blocks NextIntegrations

Last updated 7 months ago

OpenAPI block

Create a new user

Login and get JWT token

Get all projects

Create a new project

Get a project by ID

Update a project

Delete a project

Get all skills

Create a new skill

Get a skill by ID

Update a skill

Delete a skill

Get all skill categories

Get skills by category

Submit a contact message

Get all contact messages

Get a contact message by ID

Delete a contact message