API Reference

This section contains the complete API reference documentation generated from the OpenAPI specification.

v1.0.0

Sample API

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

A sample API to demonstrate vitepress-openapi

Contact

support@example.com

Servers

https://api.example.com/v1Production server

https://staging-api.example.com/v1Staging server

---

Users

User management endpoints

Operations

GET/usersPOST/usersGET/users/{userId}PUT/users/{userId}DELETE/users/{userId}

---

Get all users

GET

/users

Retrieve a list of all users

Authorizations

bearerAuth

Enter your bearer token in the format: Bearer {token}

Type

HTTP (bearer)

Parameters

Query Parameters

page

Page number

Type

integer

Default

1

limit

Number of items per page

Type

integer

Default

10

Maximum

100

Responses

Successful response

Content-Type

application/json

{

"data": [

{

"id": "string",

"name": "string",

"email": "string",

"role": "string",

"createdAt": "string",

"updatedAt": "string"

}

],

"pagination": {

"page": 0,

"limit": 0,

"total": 0,

"totalPages": 0

}

}

GET

/users

Playground

Server

Authorization

bearerAuth

Variables

Key

Value

page

limit

Samples

---

Create a user

POST

/users

Create a new user

Authorizations

bearerAuth

Enter your bearer token in the format: Bearer {token}

Type

HTTP (bearer)

Request Body

application/json

{

"name": "string",

"email": "string",

"role": "user"

}

Responses

User created successfully

Content-Type

application/json

{

"id": "string",

"name": "string",

"email": "string",

"role": "string",

"createdAt": "string",

"updatedAt": "string"

}

POST

/users

Playground

Server

Authorization

bearerAuth

Body

Samples

---

Get user by ID

GET

/users/{userId}

Retrieve a specific user by their ID

Authorizations

bearerAuth

Enter your bearer token in the format: Bearer {token}

Type

HTTP (bearer)

Parameters

Path Parameters

userId*

User ID

Type

string

Required

Responses

Successful response

Content-Type

application/json

{

"id": "string",

"name": "string",

"email": "string",

"role": "string",

"createdAt": "string",

"updatedAt": "string"

}

GET

/users/{userId}

Playground

Server

Authorization

bearerAuth

Variables

Key

Value

userId*

Samples

---

Update user

PUT

/users/{userId}

Update an existing user

Authorizations

bearerAuth

Enter your bearer token in the format: Bearer {token}

Type

HTTP (bearer)

Parameters

Path Parameters

userId*

User ID

Type

string

Required

Request Body

application/json

{

"name": "string",

"email": "string",

"role": "user"

}

Responses

User updated successfully

Content-Type

application/json

{

"id": "string",

"name": "string",

"email": "string",

"role": "string",

"createdAt": "string",

"updatedAt": "string"

}

PUT

/users/{userId}

Playground

Server

Authorization

bearerAuth

Variables

Key

Value

userId*

Body

Samples

---

Delete user

DELETE

/users/{userId}

Delete a user by ID

Authorizations

bearerAuth

Enter your bearer token in the format: Bearer {token}

Type

HTTP (bearer)

Parameters

Path Parameters

userId*

User ID

Type

string

Required

Responses

User deleted successfully

DELETE

/users/{userId}

Playground

Server

Authorization

bearerAuth

Variables

Key

Value

userId*

Samples

---

Posts

Post management endpoints

Operations

GET/postsPOST/posts

---

Get all posts

GET

/posts

Retrieve a list of all posts

Authorizations

bearerAuth

Enter your bearer token in the format: Bearer {token}

Type

HTTP (bearer)

Parameters

Query Parameters

page

Page number

Type

integer

Default

1

limit

Number of items per page

Type

integer

Default

10

Maximum

100

Responses

Successful response

Content-Type

application/json

{

"data": [

{

"id": "string",

"title": "string",

"content": "string",

"authorId": "string",

"published": true,

"createdAt": "string",

"updatedAt": "string"

}

],

"pagination": {

"page": 0,

"limit": 0,

"total": 0,

"totalPages": 0

}

}

GET

/posts

Playground

Server

Authorization

bearerAuth

Variables

Key

Value

page

limit

Samples

---

Create a post

POST

/posts

Create a new post

Authorizations

bearerAuth

Enter your bearer token in the format: Bearer {token}

Type

HTTP (bearer)

Request Body

application/json

{

"title": "string",

"content": "string",

"published": false

}

Responses

Post created successfully

Content-Type

application/json

{

"id": "string",

"title": "string",

"content": "string",

"authorId": "string",

"published": true,

"createdAt": "string",

"updatedAt": "string"

}

POST

/posts

Playground

Server

Authorization

bearerAuth

Body

Samples

---

Powered by VitePress OpenAPI