Skip to main content

Getting Started

The StuartDoesDev API serves the StuartDoesDev branding site and future projects. This guide gives you a high-level overview of how to work with it.

Base URL​

Use the API base URL for all requests (for example, in production: https://api.stuartdoesdev.co.uk). The exact base URL is environment-specific.

Public vs authenticated​

The API has two kinds of surface:

  • Public endpoints — No authentication required. Examples: submitting a contact message, reading published blog posts, signing in or signing up.
  • Authenticated endpoints — Require a valid JWT in the Authorization header. Some of these are restricted to elevated roles (e.g. admin) for managing content and operations.

For details on how to obtain and send a token, see Authentication. For a list of resource areas and whether they are public or protected, see Resources.

Next steps​

  • Resources — Overview of Contact, Blog, Auth, and admin capabilities.
  • Authentication — How to get a JWT and use it.
  • OpenAPI — Link to the machine-readable API spec and request/response schemas.