Skip to content

Commit 4315fca

Browse files
committed
docs: add static API overview page
1 parent 4490997 commit 4315fca

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

site/api/index.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: API Reference
3+
---
4+
5+
# API Reference
6+
7+
The Star Wars CAP Showcase exposes its services on three protocols simultaneously:
8+
9+
| Protocol | Base path | Best for |
10+
| --- | --- | --- |
11+
| OData v4 | `/odata/v4/<Service>/` | Fiori UI, SAP integration, standard tooling |
12+
| REST | `/rest/<Service>/` | Simple HTTP clients, scripting |
13+
| GraphQL | `/graphql/` | Flexible ad-hoc queries, developer tooling |
14+
15+
## Services
16+
17+
| Service | Description | Full API reference |
18+
| --- | --- | --- |
19+
| **DataService** | Read-only projection of all Star Wars entities — Films, People, Planets, Species, Starships, Vehicles, Shows, Episodes | [Data Service API](/api/data-service) |
20+
| **StarWarsFilm** | Draft-enabled Film CRUD with junction navigation | [Film API](/api/film) |
21+
22+
The generated reference pages below are produced by [Widdershins](https://github.com/Mermade/widdershins) from the OpenAPI 3.0 specs at `cap/docs/*.openapi3.json`.
23+
24+
> **Tip:** Start the server with `npm run sqlite` and browse to `http://localhost:4004/api-docs` for an interactive Swagger UI that covers all services.

0 commit comments

Comments
 (0)