用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

Standards Tree 标准树

这有三个不同的树: x,prs 和 vnd。你使用的标准树需要取决于你开发的项目

未注册的树(x)主要表示本地和私有环境

私有树(prs)主要表示没有商业发布的项目

供应商树(vnd)主要表示公开发布的项目 

子类型SUBTYPE

子类型通常是应用程序或项目的短名称,都是小写的。

前缀PREFIX (比如www.z5w.net/api/)

如果你曾经使用过 API 你就会知道大多数服务都来自子域或前缀。前缀或子域是必须的,但只需要一个。请避免使用版本号作为你的前缀或子域,因为版本控制是通过 header 头 Accept 处理的。

子域名API_DOMAIN

比如可以用api.z5w.net来做api的调用地址。如果已经设置了前缀prefix,则domain一般设为null

版本号version

这个版本号是你的 API 的默认版本号,并且会在一些未提供版本号的情况下作为回调的默认值使用。在生成 API 文档时也会使用这个版本号作为默认值。

名称Name

你的 API 的名称只会在你使用 API Blueprint 命令生成文档的时候使用。使用此名称可以避免你每次生成文档的时候都必须手动定义名称。
你可能需要把它用引号包起来。

条件请求CONDITIONAL_REQUEST

『条件请求』默认为开启状态,这有利于客户端的缓存机制在可能的情况下缓存 API 请求。

严格模式STRICT

严格模式要求客户端发送 Accept 头,代替配置文件中配置的默认版本。这意味着你将不能通过浏览器直接访问你的 API。

如果开启严格模式,发送非法的 Acceept 标头会抛出一个未处理的异常 Symfony\Component\HttpKernel\Exception\BadRequestHttpException ,你需要自己处理这个异常。

调试模式Debug

该包处理的通用错误包括一个 debug 键,当启用这个键时,将会填充堆栈跟踪详细信息。

2,在/routes/web.php添加路由

$api = app(‘Dingo\Api\Routing\Router‘);
$api->version(‘v1‘, function ($api) {
    $api->get(‘helloworld‘, ‘App\Api\Controllers\[email protected]‘);
});

  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 ‘{content:Helloworld!}‘;
    }
}

  4,测试路由: $ php artisan api:routes,如果出现

+------+----------+-----------------+------+-------------------------------------------+-----------+------------+----------+------------+
| Host | Method   | URI             | Name | Action                                    | Protected | Version(s) | Scope(s) | Rate Limit |
+------+----------+-----------------+------+-------------------------------------------+-----------+------------+----------+------------+
|      | GET|HEAD | /api/helloworld |      | App\Api\Controllers\[email protected] | No        | v1         |          |            |
+------+----------+-----------------+------+-------------------------------------------+-----------+------------+----------+------------+

  表示成功

  然后访问http://www.*.com/api/helloworld,看看是不是出现了api的json数据呢?

{content:Helloworld!}

原文地址:https://www.cnblogs.com/ytkah/p/9280932.html

时间: 2024-12-17 02:52:00

用laravel dingo/api创建简单的api的相关文章

laravel dingo/api添加jwt-auth认证

前面我们学了laravel dingo/api创建简单的api,这样api是开放给所有人的,如何查看和限制api的调用呢?可以用jwt-auth来验证,JSON Web Token Authentication 1,首先安装jwt-auth插件,在命令行中用composer安装 composer require tymon/jwt-auth '0.5.*' 2,然后发布 php artisan vendor:publish --provider="Tymon\JWTAuth\Providers\

IdentityServer3——入门教程:创建简单的OAuth2.0服务器,客户端和API

本教程的目的在于创造尽可能简单的identityserver安装作为一个oauth2授权服务器.这应该能够让你了解一些基本功能和配置选项(完整的源代码可以发现在这里).在后面的文档中会介绍更多的高级功能.本教程包括: 创建一个自托管identityserver 设置为使用一个应用程序的帐户以及用户对通信应用的客户服务代表 注册一个API 请求访问令牌 调用API 验证一个访问令牌 创建一个授权服务器(IdentityServer3) 创建一个控制台应用程序,并且在程序包管理器控制台中输入 ins

使用PHP创建一个REST API(译)

最近API在网络领域有些风靡,明确的说是REST的影响力.这实在没什么好惊讶的,因为在任何编程语言中,消费REST API都是非常的容易.构建它也非常的简单,因为本质上你不会用到任何那些已存在很久的HTTP细则.由于Rails对REST做出的深思熟虑的支持,包括提供和消费这些API(这已经被所有那些和我共事的Rails狂热者阐述过),我要赞美Rails,这样的事情并不常发生. 说真的,如果你从未使用过REST,但是使用过(或者更糟糕的,构建过)SOAP API,或仅仅开过一个WSDL并且将你报价

创建一个提供数据 API 的 Node.js 网站

创建站点目录 首先,创建一个文件夹用来保存你的站点文件,使用 mkdir 就可以了 PS C:\> mkdir mysite 然后,进入到这个文件夹进行下一步的操作. 创建包说明 使用记事本或者你喜欢的任何纯文本编辑器创建 package.json 文件,文件名是一个约定必须是这个名字. 创建本网站自身的说明,说明依赖的其它包. { "name": "express-api", "version": "0.0.1", &

在ASP.NET Core MVC中构建简单 Web Api

Getting Started 在 ASP.NET Core MVC 框架中,ASP.NET 团队为我们提供了一整套的用于构建一个 Web 中的各种部分所需的套件,那么有些时候我们只需要做一个简单的 Web Api 程序怎么办呢? 在 GitHub 中的 ASP.NET Core MVC 源码里面,我们只要关注 Microsoft.AspNetCore.Mvc 这个包,那么除了这个包之外它还包含这些: Microsoft.AspNetCore.Mvc.ApiExplorer Microsoft.

JQuery + ASP.Net Web API一个简单应用

一.使用JQuery + ASP.Net Web API创建一个简单的CRUD应用 该Demo模拟联系人管理(Contact).页面加载时列出所有的联系人,同时支持增.删.改操作.页面效果如下: 二.通过ASP.NET Web API提供服务 通过Visual Studio创建一个Web API项目,在Model中增加表示联系人的Contact,定义如下: public class Contact { public string Id { get; set; } public string Fi

使用 Swagger UI 与 Swashbuckle 创建 RESTful Web API 帮助文件

作者:Sreekanth Mothukuru 2016年2月18日 本文旨在介绍如何使用常用的 Swagger 和 Swashbuckle 框架创建描述 Restful API 的交互界面,并为 API 用户提供丰富的探索.文件和操作体验. 源代码: 下载 SwaggerUi_2.zip 步骤 在本文中,我们将在 Asp.Net 创建一个简单的 Restful API,并整合 Swashbuckle 和 Swagger UI.本文分为三部分. 创建 Asp.Net Web API项目 通过实体数

利用Hadoop提供的RPC API实现简单的RPC程序

[toc] 利用Hadoop提供的RPC API实现简单的RPC程序 在Hadoop中提供了RPC服务的使用API,通过其API地使用,可以非常简单地构建远程过程调用程序,下面就给出一个简单的实例. 项目结构 为了方便操作,所有的代码都放在本地一个项目中,实际上,完全可以将代码放在不同的服务器上,这是RPC的概念,这里就不做过多的介绍.项目结构如下: rpc/ ├── HelloServiceImpl.java ├── IHelloService.java ├── RPCClientDriver

Web Api ——创建WebAPI

Web Api --创建WebAPI 方法在Win10 + VS2017(MVC5)测试通过 1.建立 WebApi项目: 选择菜单 "文件->新建醒目->web ->ASP.NET Web 应用程序" 输入项目名称和位置,确定,进入模板选择页面. 选择 WEB API 模板(选择Web API 时会添加对MVC 的支持) 2.添加ApiController 查看生产的目录结构,发现WebAPI 的结构和普通MVC程序结构是非常类似的. 默认VS会在Controlle