Skip to content

datawire/stoplight-openapi-php-server

 
 

Repository files navigation

OpenAPIServer

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Symfony bundle is automatically generated by the OpenAPI Generator project:

  • API version: api-v1
  • Generator version: 7.14.0-SNAPSHOT
  • Build package: org.openapitools.codegen.languages.PhpSymfonyServerCodegen

Requirements

PHP 8.0 and later

Installation & Usage

To install the dependencies via Composer, add the following repository to composer.json of your Symfony project:

{
    "repositories": [{
        "type": "path",
        "url": "//Path to your generated openapi bundle"
    }],
}

Then run:

composer require GIT_USER_ID/GIT_REPO_ID:dev-master

to add the generated openapi bundle as a dependency.

Tests

To run the unit tests for the generated bundle, first navigate to the directory containing the code, then run the following commands:

composer install
./vendor/bin/phpunit

Getting Started

Step 1: Please follow the installation procedure first.

Step 2: Enable the bundle in the bundle configuration:

// app/config/bundles.php
return [
    // ...
    OpenAPI\Server\OpenAPIServerBundle::class => ['all' => true],
];

Step 3: Register the routes:

# app/config/routes.yaml
open_api_server:
    resource: "@OpenAPIServerBundle/Resources/config/routing.yaml"

Step 4: Implement the API calls:

<?php
// src/Acme/MyBundle/Api/DefaultApi.php

namespace Acme\MyBundle\Api;

use OpenAPI\Server\Api\DefaultApiInterface;

class DefaultApi implements DefaultApiInterface // An interface is autogenerated
{

    // Other operation methods ...
}

Step 5: Tag your API implementation:

# config/services.yaml
services:
    # ...
    Acme\MyBundle\Api\DefaultApi:
        tags:
            - { name: "open_api_server.api", api: "default" }
    # ...

Now you can start using the bundle!

Documentation for API Endpoints

All URIs are relative to https://api.stoplight.io/v1

Class Method HTTP request Description
DefaultApiInterface pOSTVersionsPublishAnon POST /versions/publish/anon Publish Anonymous
VersionsApiInterface gETVersionsVersionIdExportFormat GET /versions/{versionId}/export/{format} Export
VersionsApiInterface pOSTVersionsVersionIdPublish POST /versions/{versionId}/publish Publish
VersionsApiInterface pUTVersionsVersionIdImport PUT /versions/{versionId}/import Import
VersionsApiInterface pUTVersionsVersionIdUnpublish PUT /versions/{versionId}/unpublish Unpublish

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

Authorization

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Author

About

testing fork

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • PHP 98.6%
  • Shell 1.4%