Details
-
Story
-
Status: Closed
-
Major
-
Resolution: Done
-
None
-
None
-
None
-
Keycloak Sprint 24
-
13
-
NEW
-
NEW
Description
As a Keycloak developer I would like a REST API guideline so that I can develop consistent and user friendly REST APIs.
The guideline should cover:
- Basic functions like versioning, search, pagination
- API style guidelines
- How to generate documentation, including OpenAPI descriptions
- How to properly handle actions
- Consider if we can provide an API playground for APIs on Keycloak
The guideline will initially be used by Account Management REST API, followed by Admin API in the future.
Attachments
Issue Links
- incorporates
-
KEYCLOAK-9655 Generate OpenAPI descriptors for the Account REST API
-
- Closed
-
- is incorporated by
-
KEYCLOAK-10787 Provide recommendation about how to properly document REST APIs
-
- Closed
-
-
KEYCLOAK-10788 Provide recommendation about how to properly handle concurrency
-
- Closed
-
-
KEYCLOAK-10801 Provide recommendation about how to properly handle filtering
-
- Closed
-