laravel dingo/api를 사용하여 간단한 API 만들기-PHP 튜토리얼-php.cn

laravel dingo/api를 사용하여 간단한 API 만들기

不言

풀어 주다： 2023-04-02 21:36:01

원래의

2264명이 탐색했습니다.

이 글은 주로 laravel dingo/api를 사용하여 간단한 API를 만드는 방법을 소개합니다. 이제 필요한 친구들이 참고할 수 있도록 공유하겠습니다.

1 , 수정 .env 구성 파일에

API_STANDARDS_TREE=vnd 
API_SUBTYPE=myapp
API_PREFIX=api
API_DOMAIN=null
API_VERSION=v1
API_NAME="My API"
API_CONDITIONAL_REQUEST=false
API_STRICT=false
API_DEBUG=true

로그인 후 복사

표준 트리 표준 트리

x, prs 및 vnd의 세 가지 트리가 추가됩니다. 사용하는 표준 트리는 개발하는 프로젝트에 따라 다릅니다

등록되지 않은 트리(x)는 주로 로컬 및 개인 환경을 나타냅니다

개인 트리(prs)는 주로 상업용 게시 프로젝트가 없음을 나타냅니다 # 🎜🎜#

공급업체 트리(vnd)는 주로 공개적으로 출시된 프로젝트를 나타냅니다.

하위 유형 SUBTYPE

하위 유형은 일반적으로 짧은 이름입니다. 응용 프로그램이나 프로젝트의 이름은 모두 소문자입니다.

접두사 PREFIX (예: www.z5w.net/api/)

API를 사용해 본 적이 있다면 대부분의 내용을 알게 될 것입니다. 서비스는 모두 하위 도메인이나 접두사에서 나옵니다. 접두사 또는 하위 도메인은 필수이지만 하나만 필요합니다. 버전 관리는 Accept 헤더를 통해 처리되므로 버전 번호를 접두사 또는 하위 도메인으로 사용하지 마세요.

하위 도메인 이름 API_DOMAIN

예를 들어 API 호출 주소로 api.z5w.net을 사용할 수 있습니다. 접두사 접두사가 설정된 경우 도메인은 일반적으로 null로 설정됩니다.

버전 번호 버전

이 버전 번호는 의 기본 버전입니다. API 번호는 버전 번호가 제공되지 않는 경우 콜백의 기본값으로 사용됩니다. 이 버전 번호는 API 문서를 생성할 때 기본값으로도 사용됩니다.

NameName

API 이름은 API Blueprint 명령을 사용하여 문서를 생성할 때만 사용됩니다. 이 이름을 사용하면 문서를 생성할 때마다 이름을 수동으로 정의할 필요가 없습니다.

따옴표로 묶어야 할 수도 있습니다.

조건부 요청 CONDITIONAL_REQUEST

"조건부 요청"은 기본적으로 켜져 있습니다. 이는 클라이언트의 캐싱 메커니즘이 다음과 같은 경우에 API를 캐시하는 데 도움이 됩니다. 가능한 질문입니다.

엄격 모드 STRICT

엄격 모드에서는 클라이언트가 구성 파일에 구성된 기본 버전 대신 Accept 헤더를 보내야 합니다. 이는 브라우저를 통해 직접 API에 액세스할 수 없음을 의미합니다.

엄격 모드가 활성화된 경우 불법 Accept 헤더를 보내면 처리되지 않은 예외가 발생합니다. SymfonyComponentHttpKernelExceptionBadRequestHttpException 이 예외는 직접 처리해야 합니다.

Debug ModeDebug

이 패키지에서 처리하는 일반적인 오류에는 활성화되면 스택 추적 세부 정보가 채워지는 디버그 키가 포함됩니다.

2, /routes/web.php에 경로 추가

$api = app(&#39;Dingo\Api\Routing\Router&#39;);
$api->version(&#39;v1&#39;, function ($api) {
    $api->get(&#39;helloworld&#39;, &#39;App\Api\Controllers\HelloController@index&#39;);
});

로그인 후 복사

　3, /app/Api/Controllers/HelloController.php

<?php

namespace App\Api\Controllers;

use Illuminate\Http\Request;
use App\Http\Controllers\Controller;

class HelloController extends Controller
{
    public function index()
    {
        return &#39;{content:Helloworld!}&#39;;
    }
}

로그인 후 복사

#🎜🎜 파일 생성 #　4. 테스트 라우팅: $ php artisan api:routes,

+-----+----------+-----------------+------+-------------------------------------------+-----------+------------+----------+------------+
| Host | Method   | URI             | Name | Action                                    | Protected | Version(s) | Scope(s) | Rate Limit |
+------+----------+-----------------+------+-------------------------------------------+-----------+------------+----------+------------+
|      | GET|HEAD | /api/helloworld |      | App\Api\Controllers\HelloController@index | No        | v1         |          |            |
+------+----------+-----------------+------+-------------------------------------------+-----------+------------+----------+------------+

로그인 후 복사

이 나타나면 성공을 의미합니다.

그런 다음 http://www.*.com/api/를 방문하세요. helloworld, API의 json 데이터가 나타나는지 확인해보세요.