yiisoft / app-api Goto Github PK

This is base API application template and multilangual support is optional, so it's should be removed.

Related to yiisoft/config#121

What steps will reproduce the problem?

Clone and install app-api

What is the expected result?

Clean installation without anything else.
(Not sure about user / auth; ok in my opinion)

What do you get instead?

A blog in it, which doesn't make sense in my opinion as it is already in the demo-api.

What steps will reproduce the problem?

Try to execute any cli command with yii utility. Do not pass env variable.

What is the expected result?

As per following line of code in yii file, It should use production environment.

define('YII_ENV', getenv('env') ?? 'production');

What do you get instead?

It is using testing environment. Actually getenv('env') is evaluating to false which is not allowing to return 'production' string in YII_ENV.

Additional info

This is may be useful for CI.

Need to correct generators and schema-provider list.
SyncTables can be commented

What steps will reproduce the problem?

composer create-project yiisoft/app-api --stability=dev myproject

What is the expected result?

Successful installation

What do you get instead?

`
Creating a "yiisoft/app-api" project at "./myproject"
Info from https://repo.packagist.org: #StandWithUkraine
Installing yiisoft/app-api (1.0.x-dev c93aab6)

• Downloading yiisoft/app-api (dev-master c93aab6)
• Installing yiisoft/app-api (dev-master c93aab6): Extracting archive
  Created project in C:\src\myproject
  Loading composer repositories with package information
  Updating dependencies
  Your requirements could not be resolved to an installable set of packages.

Problem 1
- league/mime-type-detection[1.0.0, ..., 1.3.0] require php ^7.2 -> your php version (8.1.9) does not satisfy that requirement.
- league/flysystem[2.0.0-alpha.1, ..., 2.0.0-RC1] require php ^7.2 -> your php version (8.1.9) does not satisfy that requirement.`

Additional info

HI!
I´m checking this new app for generate an api. Where is the documentation? The /docs don't exist.

I think for application template PHP CS Fixer, that free for use, will be better.

See yiisoft/app#273

What steps will reproduce the problem?

After installation, when you execute psalm, you will find these errors.

What is the expected result?

It should be success after psalm execution.

What do you get instead?

ERROR: UndefinedGlobalVariable - config/packages/yiisoft/csrf/web.php:34:28 - Cannot find referenced variable $params in global scope (see https://psalm.dev/127)
            'secretKey' => $params['yiisoft/csrf']['hmacToken']['secretKey'],


ERROR: UndefinedGlobalVariable - config/packages/yiisoft/csrf/web.php:35:28 - Cannot find referenced variable $params in global scope (see https://psalm.dev/127)
            'algorithm' => $params['yiisoft/csrf']['hmacToken']['algorithm'],


ERROR: UndefinedGlobalVariable - config/packages/yiisoft/csrf/web.php:36:27 - Cannot find referenced variable $params in global scope (see https://psalm.dev/127)
            'lifetime' => $params['yiisoft/csrf']['hmacToken']['lifetime'],


ERROR: InvalidScope - config/packages/yiisoft/profiler/common.php:35:13 - Invalid reference to $this in a non-class context (see https://psalm.dev/013)
            $this->enable((bool)$params['enabled']);


ERROR: InvalidScope - config/packages/yiisoft/profiler/common.php:49:13 - Invalid reference to $this in a non-class context (see https://psalm.dev/013)
            $this->enable((bool)$params['enabled']);


------------------------------
5 errors found
------------------------------

Additional info

Now error:

[Yiisoft\Definitions\Exception\InvalidConfigException] Invalid definition: class "Yiisoft\Yii\Middleware\Locale" does not have the public method with name "withEnableSaveLocale". Possible methods to call: "process", "withSupportedLocales", "withDefaultLocale", "withQueryParameterName", "withCookieName", "withDetectLocale", "withIgnoredRequestUrlPatterns", "withSecureCookie", "withCookieDuration"

Currently annotations are very basic. These should be extended to include details about responses and request parameters.

Apache is not always used.

Currently classes are grouped by type: validation, controller, builder, formatter. I think overall the structure will be better if we'll group these by use-case:

Auth
  AuthController.php
  AuthRequestErrorHandler.php
  AuthRequest.php
Blog
  BlogController.php
  PostBuilder.php
  Post.php
  PostStatus.php
  PostFormatter.php
  PostRepository.php
  BlogService.php
  EditPostRequest.php
  ViewPostRequest.php
Site
  SiteController.php
User
  UserController.php
  User.php
  UserFormatter.php
  UserRepository.php
  UserService.php

When trying follow to the swagger documentation at the link http://localhost:8080/docs, an error occurs: Invalid path alias: @vendor/swagger-api/swagger-ui/dist

See: https://github.com/yiisoft/request-provider?tab=readme-ov-file#general-usage

https://github.com/yiisoft/yii-swagger

Add using ApplicationRunner in index-test.php similar to index.php.

See yiisoft/app#272

See https://github.com/yiisoft/app/blob/master/.github/workflows/build.yml#L80