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.5.tar.gz.

File metadata

File hashes

Hashes for php_framework_routes_to_openapi_converter-0.1.5.tar.gz
Algorithm Hash digest
SHA256 717a3a6daafadf7676f60d73658c1f1d6fa3f6763fdbf10fb16a79daad6e3e89
MD5 10596cf5ea2cecee75a61c10674a5c0f
BLAKE2b-256 dc4948013129f3a920a96b8072278c37910b76717ff0b03571d36d98779b5250

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for php_framework_routes_to_openapi_converter-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 9d1d86ad4d58d40320be8bf80107a81609db8fec24ca1848cb06a36bff134b01
MD5 f81db22721622e3020c190a7174360f6
BLAKE2b-256 2eeaaaaecd54b287e317ca124194c4c6d591d8bd32ce62cc66c0eddf89dfab0d

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