Saltar al contenido principal

API — Pages

Documentacao tecnica gerada automaticamente a partir da especificacao OpenAPI.


GET /api/pages

List Pages

Parametros:

NomeTipoObrigatorioDescricao
pageintegerNao
page_sizeintegerNao

Exemplo resposta (200):

{
"items": [
"..."
],
"total": 0,
"page": 0,
"page_size": 0,
"pages": 0
}

Erros possiveis: 422 Validation Error


POST /api/pages

Create Page

Corpo do pedido:

CampoTipoObrigatorioDescricao
slugstringSimSlug
titlestringSimTitle
contentobjectNaoContent
is_activebooleanNaoIs Active
display_orderintegerNaoDisplay Order
meta_titleobjectNaoMeta Title
meta_descriptionobjectNaoMeta Description

Exemplo pedido:

{
"slug": "string",
"title": "string",
"content": null,
"is_active": true,
"display_order": 0,
"meta_title": null,
"meta_description": null
}

Exemplo resposta (201):

{
"id": 0,
"slug": "string",
"title": "string",
"content": null,
"is_active": true,
"display_order": 0,
"meta_title": null,
"meta_description": null,
"created_at": null,
"updated_at": null
}

Erros possiveis: 422 Validation Error


GET /api/pages/{slug}

Get Page By Slug

Parametros:

NomeTipoObrigatorioDescricao
slugstringSim

Exemplo resposta (200):

{
"id": 0,
"slug": "string",
"title": "string",
"content": null,
"is_active": true,
"display_order": 0,
"meta_title": null,
"meta_description": null,
"created_at": null,
"updated_at": null
}

Erros possiveis: 422 Validation Error


PUT /api/pages/{page_id}

Update Page

Parametros:

NomeTipoObrigatorioDescricao
page_idintegerSim

Corpo do pedido:

CampoTipoObrigatorioDescricao
slugobjectNaoSlug
titleobjectNaoTitle
contentobjectNaoContent
is_activeobjectNaoIs Active
display_orderobjectNaoDisplay Order
meta_titleobjectNaoMeta Title
meta_descriptionobjectNaoMeta Description

Exemplo pedido:

{
"slug": null,
"title": null,
"content": null,
"is_active": null,
"display_order": null,
"meta_title": null,
"meta_description": null
}

Exemplo resposta (200):

{
"id": 0,
"slug": "string",
"title": "string",
"content": null,
"is_active": true,
"display_order": 0,
"meta_title": null,
"meta_description": null,
"created_at": null,
"updated_at": null
}

Erros possiveis: 422 Validation Error


DELETE /api/pages/{page_id}

Delete Page

Parametros:

NomeTipoObrigatorioDescricao
page_idintegerSim

Resposta (204): Successful Response

Erros possiveis: 422 Validation Error


Documentacao gerada automaticamente.