laravel_php 스킬을 기반으로 APP 인터페이스(API) 만들기

준비

서문, 왜, 무엇을 해야 하는지
제 성은 바이(Bai)이고, 프로그래밍의 진정한 초보입니다. 하지만 1학년 때 프로그래밍이라는 멋진 것을 접한 이후로 저는 프로그래밍의 세계에 완전히 빠져들었습니다.

아니요, 최근에는 APP을 다루기 시작했습니다. 이제 JavaScript와 약간의 HTML CSS 기술만 있으면 APP 개발이 정말 쉽습니다. 하지만 APP의 백엔드는 다릅니다. APP를 개발하고 일부 데이터를 읽으려면 백엔드를 개발해야 합니다.

laravel 프레임워크는 제가 가장 좋아하는 PHP 프레임워크입니다. 작년에 나는 laravel을 사용하여 개인 웹사이트를 작성했지만 거칠기 때문에 얼굴이 붉어졌습니다. 자세한 내용은 생략하고 바로 주제로 넘어가겠습니다. 먼저 laravel을 설치하십시오!

기본 환경 구성

구체적인 단계는 Laravel5.2 설치 설명서를 직접 참조하세요

저만의 환경은 win10에 wampsrver2.5가 설치되어 있다는 것인데, wampsrver2.5를 사용한다면 주목할 만한 부분입니다. 이에 대해서는 제 메모를 읽어보시고 미리보기를 클릭해 주세요
도구: 숭고함
브라우저: 크롬(포스트맨 플러그인 사용)

API 소개

API(애플리케이션 프로그래밍 인터페이스, 애플리케이션 프로그래밍 인터페이스)는 애플리케이션과 개발자에게 소스 코드에 액세스하지 않고도 특정 소프트웨어나 하드웨어를 기반으로 하는 루틴 세트에 액세스하거나 내부 작업의 세부 사항을 이해할 수 있는 기능을 제공하는 사전 정의된 기능입니다. .
API에는 특정 목적이 있으므로 API가 수행하는 작업을 알아야 합니다. API에 접근할 때 입력해야 할 내용입니다. API에 액세스한 후 무엇을 얻을 수 있습니까?

API 설계를 시작할 때 주의해야 할 8가지 사항
여기 내용은 마스터 블로그
에서 발췌한 내용입니다. 후속 개발 계획은 이를 중심으로 진행될 것입니다. (정말 훌륭한 요약)

1.편안한 디자인 원칙
2. API 명명
3.API보안
4.API가 데이터를 반환합니다
5. 이미지 처리
6. 프롬프트 정보 반환
7. 온라인 API 테스트 문서
8. 앱이 시작되면 초기화 API를 호출하여 필요한 정보를 얻습니다

laravel로 API 개발

처음부터 공부를 시작할까 고민하던 중에 발견한 플러그인인 dingo/api가 있으니 지금 설치해 볼까요!
우선 정확하게 다운로드를 하셔야 합니다
새로 설치된 laravel Composer.json에 다음 내용을 추가하세요

그런 다음 cmd를 열고 실행하세요

composer update

config/app.php의 공급자에

추가

App\Providers\OAuthServiceProvider::class,
Dingo\Api\Provider\LaravelServiceProvider::class,
LucaDegasperi\OAuth2Server\Storage\FluentStorageServiceProvider::class,
LucaDegasperi\OAuth2Server\OAuth2ServerServiceProvider::class,

별칭에

추가

'Authorizer' => LucaDegasperi\OAuth2Server\Facades\Authorizer::class,

app/Http/Kernel.php 파일의 콘텐츠 수정

protected $middleware = [\LucaDegasperi\OAuth2Server\Middleware\OAuthExceptionHandlerMiddleware::class,
];
protected $routeMiddleware = [
  'oauth' => \LucaDegasperi\OAuth2Server\Middleware\OAuthMiddleware::class,
  'oauth-user' => \LucaDegasperi\OAuth2Server\Middleware\OAuthUserOwnerMiddleware::class,
  'oauth-client' => \LucaDegasperi\OAuth2Server\Middleware\OAuthClientOwnerMiddleware::class,
  'check-authorization-params' => \LucaDegasperi\OAuth2Server\Middleware\CheckAuthCodeRequestMiddleware::class,
  'csrf' => \App\Http\Middleware\VerifyCsrfToken::class,
];

그런 다음 실행하세요

php artisan vendor:publish 
php artisan migrate

.env 파일에 이러한 구성을 추가하세요

API_STANDARDS_TREE=x
API_SUBTYPE=휴식
API_NAME=REST
API_PREFIX=api
API_VERSION=v1
API_CONDITIONAL_REQUEST=참
API_STRICT=거짓
API_DEBUG=참
API_DEFAULT_FORMAT=json

appconfigoauth2.php 파일 수정

'grant_types' => [
  'password' => [
    'class' => 'League\OAuth2\Server\Grant\PasswordGrant',
    'access_token_ttl' => 604800,
    'callback' => '\App\Http\Controllers\Auth\PasswordGrantVerifier@verify',
  ],
],

새 서비스 제공자를 생성하고 다음 콘텐츠로 app/Providers 아래에 새 OAuthServiceProvider.php 파일을 생성합니다

namespace App\Providers;

use Dingo\Api\Auth\Auth;
use Dingo\Api\Auth\Provider\OAuth2;
use Illuminate\Support\ServiceProvider;

class OAuthServiceProvider extends ServiceProvider
{
  public function boot()
  {
    $this->app[Auth::class]->extend('oauth', function ($app) {
      $provider = new OAuth2($app['oauth2-server.authorizer']->getChecker());

      $provider->setUserResolver(function ($id) {
        // Logic to return a user by their ID.
      });

      $provider->setClientResolver(function ($id) {
        // Logic to return a client by their ID.
      });

      return $provider;
    });
  }

  public function register()
  {
    //
  }
}

그런 다음 Routes.php를 열고 관련 경로를 추가하세요

//Get access_token
Route::post('oauth/access_token', function() {
   return Response::json(Authorizer::issueAccessToken());
});

//Create a test user, you don't need this if you already have.
Route::get('/register',function(){
  $user = new App\User();
   $user->name="tester";
   $user->email="test@test.com";
   $user->password = \Illuminate\Support\Facades\Hash::make("password");
   $user->save();
});
$api = app('Dingo\Api\Routing\Router');

//Show user info via restful service.
$api->version('v1', ['namespace' => 'App\Http\Controllers'], function ($api) {
  $api->get('users', 'UsersController@index');
  $api->get('users/{id}', 'UsersController@show');
});

//Just a test with auth check.
$api->version('v1', ['middleware' => 'api.auth'] , function ($api) {
  $api->get('time', function () {
    return ['now' => microtime(), 'date' => date('Y-M-D',time())];
  });
});

다음 내용으로 각각 BaseController.php와 UsersController.php를 생성하세요

//BaseController
namespace App\Http\Controllers;

use Dingo\Api\Routing\Helpers;
use Illuminate\Routing\Controller;

class BaseController extends Controller
{
  use Helpers;
}

//UsersController
namespace App\Http\Controllers;

use App\User;
use App\Http\Controllers\Controller;

class UsersController extends BaseController
{

  public function index()
  {
    return User::all();
  }

  public function show($id)
  {
    $user = User::findOrFail($id);
    // 数组形式
    return $this->response->array($user->toArray());
  }
}

그런 다음 app/Http/Controllers/Auth/ 아래에 다음 내용으로 PasswordGrantVerifier.php를 생성하세요

namespace App\Http\Controllers\Auth;
use Illuminate\Support\Facades\Auth;

class PasswordGrantVerifier
{
  public function verify($username, $password)
  {
     $credentials = [
      'email'  => $username,
      'password' => $password,
     ];

     if (Auth::once($credentials)) {
       return Auth::user()->id;
     }

     return false;
  }
}

데이터베이스의 oauth_client 테이블을 열고 새 클라이언트 데이터를 추가하세요

INSERT INTO 'oauth_clients' ('id', 'secret', 'name', 'created_at', 'updated_at') VALUES ('1', '2', 'Main website', '2016–03–13 23:00:00', '0000–00–00 00:00:00');

그럼 Happy Testing으로 넘어갈 차례입니다. 여기서 테스트할 API는

새 사용자 추가

http://localhost/register

모든 사용자 정보 읽기

http://localhost/api/users

사용자 ID가 4인 정보만 반환

http://localhost/api/users/4

access_token 받기

http://localhost/oauth/access_token

토큰 값을 이용해 시간을 구합니다. 토큰 값이 올바른 경우에만 올바른 값이 반환됩니다

http://localhost/api/time

PostMan 열기