Skip to content

API.md

Latest commit

 

History

History
96 lines (66 loc) · 3.4 KB

API.md

File metadata and controls

96 lines (66 loc) · 3.4 KB
Raw

API Documentation

Note: As a static site (SSG), this project does not expose a dynamic REST API. However, it generates static feed endpoints at build time.

📡 Public Endpoints

These endpoints are generated during the build process and are available publicly.

1. RSS Feed

Provides the latest projects/posts in XML format.

  • URL: /rss.xml
  • Method: GET
  • Format: RSS 2.0 (XML)
  • Usage: Used by RSS readers and content aggregators.
  • Content: Title, Description, Link, PubDate for each project.

Example Response:

<?xml version="1.0" encoding="UTF-8"?>
<rss version="2.0">
  <channel>
    <title>Samuel Dulex | Connecter, Communiquer, Captiver</title>
    <description>Créateur de contenu visuel...</description>
    <link>https://portfolio.kuasar.xyz/</link>
    <item>
      <title>Project Title</title>
      <link>https://portfolio.kuasar.xyz/project/project-slug/</link>
      <description>Project description...</description>
      <pubDate>Mon, 01 Jan 2024 00:00:00 GMT</pubDate>
    </item>
  </channel>
</rss>

2. Sitemap Index

Standard sitemap index for search engines.

  • URL: /sitemap-index.xml
  • Method: GET
  • Format: XML
  • Usage: SEO / Search Engine Crawlers.

Example Response:

<?xml version="1.0" encoding="UTF-8"?>
<sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
  <sitemap>
    <loc>https://portfolio.kuasar.xyz/sitemap-0.xml</loc>
  </sitemap>
</sitemapindex>

3. Robots.txt

Directives for search engine crawlers.

  • URL: /robots.txt
  • Method: GET
  • Format: Plain Text
  • Usage: SEO / Crawling Control.

🔐 Authentication

No authentication is required.

Auth expectations: No authentication is required or expected for this static setup. Since this is a fully static portfolio generated at build time (SSG), there are no dynamic APIs, databases (Prisma), or user sessions exposed to the client. All endpoints are public and read-only. If a dynamic backend (such as Hono) were ever added, it would be expected to implement its own standard authentication expectations (like API keys or Bearer tokens).

❌ Error Format

Error format: The standard error format simply falls back to standard HTTP error pages served by the host (Cloudflare Pages), rather than custom JSON payloads.

As this is a static site, API errors are primarily HTTP-level responses served by the hosting provider (Cloudflare Pages).

  • 404 Not Found: Returns the standard HTML page defined in src/pages/404.astro.
  • 500 Server Error: (Rare) Returns a generic Cloudflare error page if the CDN fails to serve the static asset.

There are no custom JSON error payloads since there are no dynamic JSON endpoints or Hono backend routing to generate them.

🛑 Rate Limiting

Current Status: As a static site (SSG) hosted on Cloudflare Pages, rate limiting is handled entirely at the CDN level. There are no application-level rate limits configured since there are no dynamic backend endpoints processing complex logic or database queries.

Hono REST API Format (Hypothetical)

If a dynamic REST API were implemented using Hono:

  • Request Format: JSON bodies for POST/PUT requests.
  • Error Format: { "error": "Message", "status": 400 }
  • Auth Expectations: Bearer tokens (JWT) in the Authorization header would be expected for protected endpoints.