README

为 Symfony 4 设计的简单 REST API

结构

如果以下任何一项适用于您的项目，则目录结构应遵循行业最佳实践，命名如下。

bin/        
config/
src/
tests/
vendor/

安装

通过 Composer

$ composer require Sf4/Api

使用方法

config/routes.yaml

api_default:
    path: /
    methods: [GET, OPTIONS]
    
api_site:
    path: /site/{token}
    methods: [GET, OPTIONS]
    

config/services.yaml

services:
    parameters:
        # ...
        api_token: '%env(resolve:API_TOKEN)%'

#   ...

    Sf4\Api\Services\TagAwareCacheAdapter: ~
    Sf4\Api\Services\CacheAdapterInterface: '@Sf4\Api\Services\TagAwareCacheAdapter'

    Sf4\Api\Repository\RepositoryFactory:
        class: Sf4\Api\Repository\RepositoryFactory
        arguments:
            $entityManager: '@Doctrine\ORM\EntityManagerInterface'
            $entities:      []

    Sf4\Api\EventSubscriber\RequestSubscriber: ~
    Sf4\Api\RequestHandler\RequestHandlerInterface:
        class: Sf4\Api\RequestHandler\RequestHandler
        calls:
            -   method: setEntityManager
                arguments:
                    -   '@Doctrine\ORM\EntityManagerInterface'
            -   method: setTranslator
                arguments:
                    -   '@Symfony\Component\Translation\TranslatorInterface'
            -   method: setDispatcher
                arguments:
                    -   '@Symfony\Component\EventDispatcher\EventDispatcherInterface'
            -   method: setRepositoryFactory
                arguments:
                    -   '@Sf4\Api\Repository\RepositoryFactory'
            -   method: setCacheAdapter
                arguments:
                    -   '@Sf4\Api\Services\CacheAdapterInterface'
            -   method: setSites
                arguments:
                    -
                        -   { site: 'parent', url: null, token: null }
                        # -   { site: 'parent', url: 'parent.example.com', token: 'API_TOKEN' }
                        # -   { site: 'example', url: 'site.example.com', token: 'API_TOKEN' }
            -   method: setAvailableRoutes
                arguments:
                    -   api_default: 'Sf4\Api\Request\DefaultRequest'
                        api_site: 'Sf4\Api\Request\SiteRequest'

config/packages/translation.yaml

framework:
    # ...
    translator:
        # ...
        paths:
            # ...
            - '%kernel.project_dir%/vendor/sf4/api/src/translations'

测试

$ composer test

贡献

请参阅CONTRIBUTING和CODE_OF_CONDUCT以获取详细信息。

安全

如果您发现任何与安全相关的问题，请通过电子邮件siim.liimand@gmail.com联系，而不是使用问题跟踪器。

致谢

• Siim Liimand

许可证

MIT 许可证（MIT）。请参阅许可证文件获取更多信息。