Knowledge Base - Guide API

Introduction

This section provides an overview of the Guide API. It allows you to retrieve information about various knowledge base articles. The API is designed to be lightweight and efficient, primarily returning JSON data.

API Endpoints
Endpoint: /articles
Method: GET
Description: Retrieves a list of all available knowledge base articles.
Parameters (Optional):
  • category: Filter articles by category.
  • search: Search articles by title or content.
  • limit: Limit the number of articles returned (default: 20).
  • offset: Page offset for pagination (default: 0).

Example: `/articles?category=security&limit=10`
Endpoint: /articles/{articleId}
Method: GET
Description: Retrieves a specific knowledge base article by its ID.
Parameters:
  • articleId: The unique identifier of the article.

Example: `/articles/123`
Response Format

The API returns data in JSON format. Here's an example: 

                
                {
                  "id": 123,
                  "title": "Understanding Authentication",
                  "content": "Detailed explanation of authentication concepts...",
                  "category": "security",
                  "author": "John Doe",
                  "dateCreated": "2023-10-26T10:00:00Z"
                }