# KRKplaysTennis API

> The KRKplaysTennis API rates amateur tennis players in Kraków from real match results. KRKplaysTennis is a fictional API, built as a technical writing portfolio: every example runs against a local mock server.

- The OpenAPI 3.1 spec is the most precise source for paths, parameters, and schemas: https://saverio-cirillo.com/krk-plays-tennis-api/openapi.yaml
- Every page is also available as Markdown: add `.md` to its URL without the trailing slash, for example https://saverio-cirillo.com/krk-plays-tennis-api/quickstart.md
- To try requests, start the mock with `npx @stoplight/prism-cli@5 mock https://saverio-cirillo.com/krk-plays-tennis-api/openapi.yaml`, then call http://127.0.0.1:4010 with any `X-API-Key` value.
- Read operations need an API key in `X-API-Key`. `POST /matches` needs an OAuth 2.0 access token with the `matches:write` scope.

## Documentation Sets

- [Abridged documentation](https://saverio-cirillo.com/krk-plays-tennis-api/llms-small.txt): a compact version of the documentation for KRKplaysTennis API, with non-essential content removed
- [Complete documentation](https://saverio-cirillo.com/krk-plays-tennis-api/llms-full.txt): the full documentation for KRKplaysTennis API
- [Get started](https://saverio-cirillo.com/krk-plays-tennis-api/_llms-txt/get-started.txt): what the API does, a first request against the mock, and authentication
- [Guides](https://saverio-cirillo.com/krk-plays-tennis-api/_llms-txt/guides.txt): one task per page: submit a match result, explain a rating change, find opponents
- [Concepts](https://saverio-cirillo.com/krk-plays-tennis-api/_llms-txt/concepts.txt): how ratings work, with worked examples
- [Reference](https://saverio-cirillo.com/krk-plays-tennis-api/_llms-txt/reference.txt): every error type, and the changelog
- [AI agents](https://saverio-cirillo.com/krk-plays-tennis-api/_llms-txt/ai-agents.txt): plain-text versions of the docs and the read-only MCP server

## Notes

- The complete documentation includes all content from the official documentation
- The content is automatically generated from the same source as the official documentation

## Optional

- [OpenAPI spec](https://saverio-cirillo.com/krk-plays-tennis-api/openapi.yaml): The source of truth for every operation and schema, in OpenAPI 3.1 YAML.