Welcome to PointSecIO’s documentation!

PointSecIO is a framework on top of Flask that automagically handles HTTP requests defined using OpenAPI (formerly known as Swagger), supporting both v2.0 and v3.0 of the specification.

PointSecIO allows you to write these specifications, then maps the endpoints to your Python functions. This is what makes it unique from other tools that generate the specification based on your Python code. You are free to describe your REST API with as much detail as you want and then PointSecIO guarantees that it will work as you specified. We built PointSecIO this way in order to:

• Simplify the development process

• Reduce misinterpretation about what an API is going to look like

Contents:

• Quickstart
  • Prerequisites
  • Installing It
  • Running It
  • Dynamic Rendering of Your Specification
  • The Swagger UI Console
  • Server Backend
• Command-Line Interface
  • Running an OpenAPI specification
  • Running a mock server
• Routing
  • Endpoint Routing to Your Python Views
  • Automatic Routing
  • Automatic Routing with MethodViewResolver
  • Parameter Name Sanitation
  • Parameter Variable Converters
  • API Versioning and basePath
  • Swagger UI path
  • Swagger JSON
• Request Handling
  • Request Validation
  • Automatic Parameter Handling
  • Header Parameters
  • Custom Validators
• Response Handling
  • Response Serialization
  • Returning status codes
  • Returning Headers
  • Response Validation
  • Custom Validator
  • Error Handling
• Security
  • OAuth 2 Authentication and Authorization
  • Basic Authentication
  • ApiKey Authentication
  • Bearer Authentication (JWT)
  • Multiple Authentication Schemes
  • Deploying Authentication
  • HTTPS Support
• PointSecIO Cookbook
  • Wildcard path parameters
  • Custom type format
  • CORS Support
  • Logging
• Exception Handling
  • Rendering Exceptions through the Flask Handler
  • Flask Error Handler Example
  • Default Exception Handling
  • Examples of Custom Rendering Exceptions
  • Custom Exceptions
• API Reference
  • pointsecio