Skip to content

anthony-reese/securitypro-api-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 

Repository files navigation

SecurityPro API Documentation

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


About the API

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

Tools Used


Testing the API

All endpoints in the Swagger UI are fully interactive. To test them:

  1. Obtain a valid OAuth 2.0 token (real or mocked)
  2. Use the Authorize button in the Swagger UI
  3. Try any GET, POST, or DELETE method right in your browser

Usage

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.


Contact

For more information or writing samples:


About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages