This repository contains the interactive API documentation for the SecurityPro API, a secure, RESTful platform for managing users, authentication, and role-based access control.
Live Documentation
You can explore the live Swagger UI here:
https://anthony-reese.github.io/securitypro-api-docs
The SecurityPro API supports:
- OAuth 2.0 authentication and token management
- User creation, retrieval, update, and deletion
- Role assignment and access control
- JSON and XML response formats
- Secure integration via HTTPS and Bearer tokens
- Swagger UI – for rendering interactive API documentation
- OpenAPI 3.0 Specification – for defining the API contract
- GitHub Pages – for hosting the documentation
All endpoints in the Swagger UI are fully interactive. To test them:
- Obtain a valid OAuth 2.0 token (real or mocked)
- Use the
Authorizebutton in the Swagger UI - Try any
GET,POST, orDELETEmethod right in your browser
You can fork this repo to create your own interactive API documentation.
To update the API spec, modify the SecurityPro_OpenAPI.yaml file and refresh index.html.
For more information or writing samples:
- GitHub: @anthony-reese