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

File metadata

File hashes

Hashes for php_framework_routes_to_openapi_converter-0.1.2.tar.gz
Algorithm Hash digest
SHA256 398ea1c6cbf1ec4eefb2fb30fcf90eeb7455d448914e4ed3d247d23fa6cdefc6
MD5 87b88dee32010bfa6b3271733d0d5add
BLAKE2b-256 69ffd7637e484bbfa47ea19ce385ead258a355fe9b5593b6ff8ed8aabb8708c2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for php_framework_routes_to_openapi_converter-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 fd69a02cd91bf7eb327cf12ece6b492f28b56d0e6e681c8e7fbf48bc60f00eba
MD5 539ac3e2972ab5d8ae973780aa91c0dc
BLAKE2b-256 410b32863be3085e3d6f327c180c0e1232fea90105c2b7e9bbf0a21f7defc614

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