contributte / api Goto Github PK

View Code? Open in Web Editor NEW

10.0 5.0 2.0 253 KB

🆖 Powerful, documented, validated, built-in API to Nette Framework. (@nette)

Home Page: https://contributte.org/packages/contributte/api.html

License: MIT License

Makefile 1.97% PHP 98.03%

api http php middleware nette-framework contributte annotations requests responses

api's Introduction

Website 🚀 contributte.org | Contact 👨🏻‍💻 f3l1x.io | Twitter 🐦 @contributte

Usage

To install the latest version of contributte/api use Composer.

composer require contributte/api

Documentation

For details on how to use this package, check out our documentation.

Version

State	Version	Branch	Nette	PHP
dev	`^0.5`	`master`	3.1+	`>=8.1`
stable	`^0.4`	`master`	3.1+	`>=8.1`

Development

See how to contribute to this package.

This package is currently maintaining by these authors.

Consider to support contributte development team. Also thank you for using this package.

api's People

Contributors

Stargazers

Watchers

Forkers

mjurina petrparolek

api's Issues

Prefix all routes

It would be nice to be able to set in config something like

api:
    prefix: /api/v1

and then @RootPath("/foo") would mean url https://<host>/api/v1/foo

Exception - create trait with data context

Routing: simplify routing mask

middleware.api:
    class: Contributte\Api\Bridges\Middlewares\ApiDataMiddleware([
        Contributte\Api\Bridges\Middlewares\ApiRouter("^/franta/{api}{?format:\\.json|.debug}$"),
        Contributte\Api\Bridges\Middlewares\ApiContentNegotiation([
            Contributte\Api\Bridges\Middlewares\Negotiation\UrlNegotiator([
                "json": Contributte\Api\Bridges\Middlewares\Negotiation\Transformer\JsonTransformer(),
                "debug": Contributte\Api\Bridges\Tracy\Negotiation\Transformer\DebugTransformer(),
                "*": Contributte\Api\Bridges\Middlewares\Negotiation\Transformer\JsonTransformer()
            ])
        ]),
        Contributte\Api\Bridges\Middlewares\ApiEmitter()
    ])

middleware.api:
    class: Contributte\Api\Bridges\Middlewares\ApiDataMiddleware([
        Contributte\Api\Bridges\Middlewares\ApiPrefix("/franta"),
        Contributte\Api\Bridges\Middlewares\ApiContentNegotiation([
            Contributte\Api\Bridges\Middlewares\Negotiation\UrlNegotiator([
                "json": Contributte\Api\Bridges\Middlewares\Negotiation\Transformer\JsonTransformer(),
                "debug": Contributte\Api\Bridges\Tracy\Negotiation\Transformer\DebugTransformer(),
                "*": Contributte\Api\Bridges\Middlewares\Negotiation\Transformer\JsonTransformer()
            ])
        ]),
        Contributte\Api\Bridges\Middlewares\ApiEmitter()
    ])

New @Parameter annotation

@Parameter(name, desc)

New @Group annotation

To separater controllers to sections/modules.

Mapping: request/response entity

/**
 * @Path("/user/{id}")
 * @Method("POST")
 * @Mapping({
 *   @Request(My/Entity),
 *   @Response(My/Entity2),
 * })
 * @param ApiRequest $request
 * @param ApiDataResponse $response
 * @return ApiResponse
 */
public function detail(ApiRequest $request, ApiDataResponse $response) {
}