Skip to main content

Convert PHP framework routes to OpenAPI 3.0 specifications

Project description

PHP Framework Routes to OpenAPI Converter

Convert PHP framework routes to OpenAPI 3.0 specifications.

Supported Frameworks

  • Laravel
  • Symfony
  • CodeIgniter

Installation

pip install -e .

Usage

CLI

python -m php_framework_routes_to_openapi_converter.cli convert routes.json laravel openapi.json

Arguments:

  1. routes.json - Input routes file
  2. laravel - Framework name (laravel, symfony, codeigniter)
  3. openapi.json - Output OpenAPI file

Python

from php_framework_routes_to_openapi_converter import convert_routes_to_openapi

routes = [
    {"uri": "/users", "methods": ["GET"], "name": "users.index"},
    {"uri": "/users/{id}", "methods": ["GET"], "name": "users.show"},
]

spec = convert_routes_to_openapi(routes, "laravel")

Example

python example.py

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file php_framework_routes_to_openapi_converter-0.1.4.tar.gz.

File metadata

File hashes

Hashes for php_framework_routes_to_openapi_converter-0.1.4.tar.gz
Algorithm Hash digest
SHA256 573991e105e1df632a4078224a0b5d79fd8f8ef26c0a888550eb65b83d5c5eb0
MD5 a9019f9f5637ae5023ae17716d3a2be6
BLAKE2b-256 5b00e8fea68fcf3efc1f6580f2127ab309a0d04161ec158e4bc793dba2ac7faa

See more details on using hashes here.

File details

Details for the file php_framework_routes_to_openapi_converter-0.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for php_framework_routes_to_openapi_converter-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 5b8ab5950bf1ac4016c7469130b39c13eff9e1b488331ea021f299d7df8e3e3e
MD5 d08f35947ebb26f8af6df1ce9ab98570
BLAKE2b-256 addd43a4c27ada1c4f81a3d907a0f4df4e547e2e613a7b1c7f14da07faaff890

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page