Swagger生成php restful API接口文档

发布于

背景

我们的restful api项目采用yaf框架， 整体结构简单， 我们只需要用swagger扫描 application目录即可。 下面简称我们的php项目为yaf_project.

搭建

先说下最终的文档生成流程会是什么样子,以便先有个整体的认识:
搭建完成后, 整个流程, 从文档生成到前端展现, 大体如下:

  1. 在php文件中写 swagger 格式的 /** 注释 */
  2. 用 swagger-php 内的 bin/swagger.phar 命令扫描 项目application 所在目录, 生成 swagger.json 文件
  3. 将swagger.json文件拷贝到swagger-ui中index.html指定的目录。
  4. 打开 swagger-ui 所在的 url, 就可以看到文档了. 文档中的各个 api 可以在该网址上直接访问得到数据.

实现此需求，只需要swagger如下的两个项目：

swagger-php: 扫描 php 注释的工具. 内含一个不错的例子.

swagger-ui: 用以将扫描工具生成的 swagger.json 文件内容展示在网页上.

git clone https://github.com/zircote/swagger-php.git 
git clone https://github.com/swagger-api/swagger-ui.git
或者： npm install swagger-ui-dist

文档生成工具（swagger）部署

NOTE: swagger-php 只是个工具,放在哪里都可以.

主要工作，解决composer依赖。

因为国内直接用 composer 比较蛋疼,所以最好设置下国内的那个 composer 源.

文档工具部署，需要以下三个命令：

cd swagger-php
composer config repo.packagist composer https://packagist.phpcomposer.com 
composer update

只要中间不报错,就算部署完成了. 完成后可以生成一份文档试一下. swagger-php 项目下的 Examples 目录下有一个示例php工程,里面已经用 swagger 格式写了各种接口注释, 我们来尝试生成一份文档.

执行下面命令：

cd swagger-php
mkdir json_docs
php ./bin/swagger ./Examples -o json_docs/

上面命令会扫描 Examples 目录中的php文件注释, 然后在 json_docs 目录下生成 swagger.json 文件. 这个 swagger.json 文件就是前端 swagger-ui 用来展示的我们的api文档文件.

前端swagger-ui部署

1、将 swagger-ui 项目中的 dist 文件夹或 node_modules 中的swagger-ui-dist文件夹拷贝到 yaf_project 根目录下.

1、只需要拷贝dist这个文件夹就可以，最好重命名下，比如叫swagger.

2、可以允许跨域。

2、参照： swagger官网

上述步骤完成后，访问即可。

编写PHP注释

swagger-php 项目的 Example 中已经有了很多相关例子,照着复制粘贴就可以了.

更具体的相关注释规则的文档,看这里: http://bfanger.nl/swagger-explained/#/swaggerObject

参考项目： git@arp.gitlab.innertoon.com:PHP/PHP-Standard-Library.git 分支：feature-swagger

在yaf项目的application目录中建立Swagger.php文件

建立此文件的目的是为了在swagger.json文件中生成一些统一的配置， 该文件不包含任何php代码，只写相应的Swagger注释。

<?php
/**
 * @SWG\Swagger(
 *      schemes={"http"},
 *      host="172.28.50.227:8080",
 *      consumes={"multipart/form-data"},
 *      produces={"application/json"},
 *      @SWG\Info(
 *         version="1.0.0",
 *         title="标准框架",
 *         description="标准框架，swagger应用基础准则",
 *         @SWG\Contact(
 *             email="lifuqiang@syswin.com"
 *         )
 *      ),
 *      
 *      
 *      @SWG\Tag(
 *          name="User",
 *          description="用户操作",
 *      ),
 *      
 *      @SWG\Tag(
 *          name="Forum",
 *          description="论坛操作"
 *      ),
 *      
 *      @SWG\Tag(
 *          name="Topic",
 *          description="话题操作"
 *      )
 * ),
 */

解释：

  1. schemes: 使用协议， 可填多种协议，比如http， https
  2. host: 项目地址， 该地址会作为每个接口的人url base， 拼接起来一起作为访问地址
  3. consumes: 接口默认接收的MIME类型。
  4. produces: 接口默认的回复类型，比如application/json
  5. @SWG\Tag: tag是用来给文档分类，name字段必须唯一。

结构体（Model）定义

<?php
/**
 * 论坛model
 * @author lifuqiang
 * @SWG\Definition(
 *      type="object",
 *      @SWG\Xml(name="Forum")
 * )
 */
class ForumModel extends BaseModel 
{
    /**
     * @SWG\Property(format="int32")
     * @var int
     */
    public $id;
    
    /**
     * @SWG\Property(format="string")
     * @var string
     */
    public $name;
}

Controller 中Action定义

<?php
class TopicController extends Controller
{
    /**
     * @SWG\Post(path="/topic/create",
     *      summary="添加话题",
     *      consumes={"multipart/form-data"},
     *      description="",
     *      tags={"Topic"},
     *      operationId="createTopic",
     *      produces={"application/json"},
     *      @SWG\Parameter(
     *          in="formData",
     *          name="forumId",
     *          description="论坛Id",
     *          required=true,
     *          type="integer",
     *      ),
     *      @SWG\Parameter(
     *          in="formData",
     *          name="title",
     *          description="标题",
     *          required=true,
     *          type="string",
     *      ),
     *      @SWG\Parameter(
     *          in="formData",
     *          name="content",
     *          description="内容",
     *          required=true,
     *          type="string",
     *      ),
     *      @SWG\Parameter(
     *          in="formData",
     *          name="file",
     *          description="图片信息",
     *          required=true,
     *          type="string",
     *      ),
     *      @SWG\Response(response="default",description="操作成功")
     * )
     */
    public function createAction()
    {
    }
    
    /**
     * @SWG\Get(path="/topic/detail/id/{id}",
     *      summary="获取话题信息",
     *      description="根据话题ID获取话题信息",
     *      operationId="getTopicById",
     *      tags={"Topic"},
     *      @SWG\Parameter(
     *          name="id",
     *          in="path",
     *          description="话题id",
     *          required=true,
     *          type="integer",
     *          format="int64",
     *      ),
     *      @SWG\Response(
     *          response=200,
     *          description="操作成功",
     *          @SWG\Schema(ref="#/definitions/TopicModel"),
     *      ),
     *      @SWG\Response(
     *          response="400",
     *          description="参数错误",
     *      ),
     *      @SWG\Response(
     *          response="404",
     *          description="话题不存在"
     *      )
     * )
     */
    public function detailAction()
    {
    }
    
    /**
     * @SWG\Get(path="/forum/list",
     *      summary="获取话题列表",
     *      description="根据论坛ID获取话题列表",
     *      operationId="getTopicList",
     *      tags={"Topic"},
     *      @SWG\Parameter(
     *          name="forumId",
     *          in="query",
     *          description="论坛id",
     *          required=true,
     *          type="integer",
     *          format="int64",
     *      ),
     *      @SWG\Parameter(
     *          name="page",
     *          in="query",
     *          description="页码",
     *          required=true,
     *          type="integer",
     *          format="int64",
     *          default="1",
     *      ),
     *      @SWG\Parameter(
     *          name="pageLimit",
     *          in="query",
     *          description="每页显示数量，默认10",
     *          required=true,
     *          type="integer",
     *          format="int64",
     *          default="10"
     *      ),
     *      @SWG\Response(
     *          response=200,
     *          description="操作成功",
     *          @SWG\Schema(ref="#/definitions/TopicModel")
     *      ),
     *      @SWG\Response(
     *          response="400",
     *          description="参数错误",
     *      ),
     *      @SWG\Response(
     *          response="404",
     *          description="话题不存在"
     *      )
     * )
     */
    public function listAction()
    {
    }
    
    
}

常用字段简要说明

接口描述（@SWG\Get, @SWG\Post等）常用字段：

summary - string  
接口的简要介绍,会显示在接口标头上,不能超过120个字符  
  
description - string  
接口的详细介绍  
  
externalDocs - string  
外部文档链接  
  
operationId - string  
全局唯一的接口标识  
  
consumes - [string]  
接口接收的MIME类型  
  
produces - [string]  
接口返回的MIME类型,如 application/json  
  
schemes -   [string]  
接口所支持的协议,取值仅限: "http", "https", "ws", "wss"  
  
parameters -    [Parameter Object | Reference Object]  
参数列表

参数描述（@SWG\Parameter）常用字段：

name - string  
参数名. 通过路径传参(in 取值 "path")时有注意事项,没用到,懒得看了...  
  
in - string  
参数从何处来. 必填. 取值仅限: "query", "header", "path", "formData", "body"  
  
description - string  
参数描述. 最好别太长  
  
type - string  
参数类型. 取值仅限: "string", "number", "integer", "boolean", "array", "file"  
  
required - boolean  
参数是否必须. 通过路径传参(in 取值 "path")时必须为 true.  
  
default - *  
默认值.

更具体的相关注释规则的文档,看这里: http://bfanger.nl/swagger-explained/#/swaggerObject

来源：https://github.com/lfq618/blog/blob/master/php/Swagger%E7%94%9F%E6%88%90php%20restful%20API%E6%8E%A5%E5%8F%A3%E6%96%87%E6%A1%A3.md

评论

发表评论

此博客中的热门博文

Sniper 一个轻量级 go 业务框架的思考

发布于
Sniper 是我为部门设计的轻量级 go 业务框架。经过两年的平稳运行，至少在一定程度上印证了我当初的一些见解。现整理出来供大家参考。 涛叔：Sniper框架两周年回顾 项目源码可以从 github 获取 bilibili/sniper ? Sniper 起源于一项新业务。在转岗之前，我一直在 L 部门写 PHP 代码，遇到过如下问题： 基于 TCP 的 RPC 协议，我们都称之为 Weisai-RPC 手工维护 RPC 文档，难以及时更新 手写代码处理 RPC 入参，难以保证参数类型，如数字 1 和字符串 "1" 的区别 无法方便地查询一个请求对应的所有日志 服务拆分得很细，难以进行调用链路追踪 使用 JSON 做为配置，难改难认 难以监控服务运行状态 代码分层标准不统一 大约在 2018 年的六月底，我得知要去新的 C 部门做新业务。没有任何历史包袱，我马上着手准备，希望能全方位的解决上面提到的问题。 Go 语言 首先要解决语言选择的问题。PHP 是最熟悉的，但从过去的经验来看，无论从性能还是从代码可维护性方面考虑，PHP 都不是一个好的选择。当时有两种选择，一个是 Java，另一个是 go。平心而论，Java 是要比 Go 要成熟得多。但 Go 更加简单轻便，从 PHP 过渡成本更低。而且当时公司正在推动用 Go 重写原有的 Java 项目。自然就选了 Go。 我两年后又写了一管关于 go 与 php 对比的文章，大家可以参考一下 涛叔：go 是更好的 php RPC 协议 有了语言，接下来就要确定通信协议。首先不要使用 REST 风格接口。 REST 中看不中用。REST 的核心是资源和状态，所有的变更都对应状态的转变。 对于简单的场景，REST 看似完美，如： GET /user/123 表示查询。 但如果是发送一条短信呢？一种方案是使用 POST /sms 表示创建一条 短信资源 ，另一种方案则是 POST /sms:send 直接发送。 但不管哪种方式，都不如 RPC 调用直观，其原因有二： 一是 http 的方法（GET, POST, PUT, DELETE 等）太少，基本都是面向静态资源的，表达能力有限 二是将业务过程转成资源状态变化本身就比较烧脑，而且存在无法转化的场景 REST 还有一个比较大的问题就是 u...
阅读全文

Matomo API 官方接口详情

发布于
API接口 你可以通过调用Matomo的分析接口将数据集成到其他应用中去。这些数据包括访问数，页面网址、网页标题、用户设置、搜索引擎、关键词、推荐网站、用户浏览器 其中的请求参数和返回值需要对照官方手册来 未定义 ## API `未定义` ## Annotations `未定义` ## Contents `未定义` ## CoreAdminHome `未定义` ## CustomDimensions `未定义` ## CustomJsTracker `未定义` ## CustomVariables `未定义` ## DBStats `未定义` ## Dashboard `未定义` ## Events `未定义` ## Feedback `未定义` ## Goals `未定义` ## ImageGraph `未定义` ## LanguagesManager `未定义` ## Login `未定义` ## Marketplace `未定义` ## MobileMessaging `未定义` ## PagePerformance `未定义` ## Provider `未定义` ## SEO `未定义` ## SitesManager `未定义` ## TagManager `未定义` 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 Actions 动作（行为） Actions.get 访客分析-概述-访客概览(右边一列) Actions.getPageUrls 行为-页面 Actions.getPageUrlsFollowingSiteSearch Actions.getPageTitlesFollowingSiteSearch Actions.getEntryPageUrls 行为-进入页面 Actions.getExitPageUrls 行为-退出页面 Actions.getPageUrl 行为-通过页面的PageUrl查看详情(获取单条记录) Actions.getPageTitles 行为-页面标题 Actions.getEntryPageTitles 行为-页面标题-进入页面标题 Actions.getExitPageTitles 行为-页...
阅读全文

如何防止Cloudflare CDN背后的图片被盗连(Hotlink Protection)？

发布于
「Hotlink Protection」(直接链接保护)是经营网站经常需要去注意的一块，但为什么我们会需要「Hotlink Protection」呢？身为图文并茂的网络文章作家，最担心得就是自己的文章被别人整篇连文带图地拷贝粘贴到其它地方了。此时如果图片有套用「Hotlink Protection」的话，就可以让被盗用的图片在其它网站上「不被正常显示」出来，如此一来，就能使其它误入盗文页面的访客可以知道该篇文章是篇被盗用的文章。不同的网站架构有不同的「Hotlink Protection」的设置方式，如果您的网站有打开Cloudflare的CDN服务的话，可以参考这篇文章，来实现「Hotlink Protection」的功能。 我的网站服务器是用Nginx或Apache，难道不能直接对它们做设置吗？ 很遗憾，只要我们有激活Cloudflare的CDN服务，就无法有效地通过自己的服务器程序来设置Hotlink Protection。这是因为网页浏览器在打开您网站的图片时，会去链接Cloudflare的CDN服务器，而非我们自己的服务器，所以就算我们有在自己的服务器上制作Hotlink Protection的功能，也根本不会被触发到。 既然有Cloudflare CDN，为什么还要Hotlink Protection？被盗连的图，其流量不是不会算在我们头上吗？ 的确，有了Cloudflare CDN之后，就算图片被盗连，它主要也还是会去吃Cloudflare CDN服务器的流量。但是，您真的愿意让您文章中的图片原封不动地在盗文网站上显示出来吗？所以还是设置一下Hotlink Protection吧！ Cloudflare内置的Hotlink Protection开关 Cloudflare的控制后台中，其实就有提供一个一键套用Hotlink Protection的开关，只要打开来，就可以让有激活CDN功能的网域拥有Hotlink Protection的功能。这个开关藏在Cloudflare控制后台的「Scrape Shield」分页中。 这个Hotlink Protection一旦打开，整个有打开Cloudflare CDN服务的网域(包含子网域)下的图片链接，就只能在这整个网域(包含子网域)下打开，否则的话会直接回传HTTP的403...
阅读全文

买了车以后才知道的一些事情

发布于
1.盲区，驾校通常不教，很多人都是听别人说什么AB柱盲区，但是从来没有认真去了解过盲区的形成原理，市区的交通事故，很大一部分是因为盲区导致的，盲区可不是只有AB柱，弯道、路口、天气、路况都是盲区变化的条件，在行车过程中是会动态变化的，不要做撞车了连为什么撞都不知道的人。开车的观察如果只看后视镜，迟早出事。而且不止你要注意你的盲区，也要注意尽量不要去别人的盲区里面转悠。 2.路权，路权概念驾校通常也不讲，路权可以说是一切交规的基础，学习路权的概念，然后再去读道交法，相信你会对交规以及驾驶技巧有不一样的认识。 3.地板油，不管是什么车，不同模式，不同档位的地板油，自己找个场地试试，不要开了几年车，连自己车地板油什么感觉都不知道，关键时候能救命，还有ABS打脚的感觉，相信很多人都没有踩出来过，去试试紧急刹车，做麋鹿测试。感知不同的道路条件下，轮胎抓地力的区别。以上，不知道有多少人去逼过自己车辆的极限，一定要知道自己车性能实际表现，不是停留在纸面数据，反正我知道没有踩出过ABS的人第一次遇到打脚是会慌的。有条件的，把esp关了，漂移控车也感受一下。借别人的车同理。 4.心平气和 5.防御性驾驶是门学问，只要你坐在驾驶位上，请把路上所有人预设神经病。 6.随车装备最重要的是反光器材、灭火器、工具箱 7.市区最怕鬼探头，高速最怕追尾 8.丢车保帅，人才是最重要的，特别是高速事故。 9.气囊只有正确方式弹出才能救人，所以什么气囊上放东西的，摆挂件的，打方向盘姿势不对的，都是自废武功，你还不如买不带气囊的车，即便是形成肌肉记忆的习惯，也要去改，因为气囊上摆东西把头骨打碎的，打方向姿势不对把手崩残废的多了去了。 10.儿童座椅很重要 11.珍爱生命、远离大车 12.每天十分钟，卖车坐家中 13.红绿灯不要挂P档，特别是傍晚，至于为什么，动动你的小脑筋，我就一句话，P档设计出来就是叫你去停车场用的，不是叫你在大马路上用的。 14.看得多远，才开多快 15.开灯是为了让别人看见你，最傻逼的是晚上在路上不开灯还没有反光标的电动车 16.永远有人闯红灯，特别是凌晨，过路口和人行道一定要减速。 17.新手们，出弯和变道要加油，即便你不加油，千万别刹车。 18.安全车速是相对的，不安全车速是绝对的。 19.路边停了一排车的，从旁边过车速不要超过30 20.路边停车超过5分钟，尽量下车绕车检查或者...
阅读全文

Docker php安装扩展步骤详解

发布于
前言 此篇，主要是演示docker-php-source , docker-php-ext-install ,docker-php-enable-docker-configure 这四个命令到底是用来干嘛的，它们在PHP容器中都做了哪些事情。 很多人很不理解在Dockerfile中安装PHP扩展的时候总是出现这几个命令，本篇就就是为你揭开这些命令的神秘面纱而准备的，所有案例都是本人自己运行过的。 Docker 中的PHP容器安装扩展的方式有 通过pecl方式安装 通过php 容器中自带的几个特殊命令来安装，这些特殊命令可以在Dockerfile中的RUN命令中进行使用。 这里，我们主要讨论的是第二种方案，如何通过PHP容器中的几个特殊命令来安装PHP扩展 PHP中安装扩展有几个特殊的命令 docker-php-source docker-php-ext-install docker-php-ext-enable docker-php-ext-configure 演示这三个命令的作用 都是在PHP容器中进行演示的，PHP容器启动太简单，不作过多介绍 docker-php-source 此命令，实际上就是在PHP容器中创建一个/usr/src/php的目录，里面放了一些自带的文件而已。我们就把它当作一个从互联网中下载下来的PHP扩展源码的存放目录即可。事实上，所有PHP扩展源码扩展存放的路径： /usr/src/php/ext 里面。 格式 ： docker-php-source extract | delete 参数说明 ： * extract : 创建并初始化 /usr/src/php目录 * delete : 删除 /usr/src/php目录 案例 ： root@803cbcf702a4 :/usr/src # ls -l total 11896 #此时，并没有php目录 -rw-r--r-- 1 root root 12176404 Jun 28 03 : 23 php.tar.xz -rw-r--r-- 1 root root 801 Jun 28 03 : 23 php.tar.xz.asc root@803cbcf702a4 :/usr/src # docker-php-sour...
阅读全文

设计师别担心，微软雅黑这样使用不侵权

发布于
这几天设计圈都被一条字体侵权消息刷屏，一公司在没有获得字体版权的情况下使用微软雅黑做印刷品，样稿印刷厂印了5000万张已经全国商用，公司损失2860万，裁员42人，含8个主管。 现在各位设计师都知道，微软雅黑版权是属于方正的，并不能免费使用！在大家惊叹赔偿金额的时候，方正官方出来辟谣： 这次事件，方正字体给我们间接地上了一课：想安全使用我们的字体？乖乖付费吧。同时还告诉那些没有买过版权的公司：该交保护费了。目前事件已在百度热点搜索排名第三，也让中国很多非设计行业人员了解了方正。 不过在大家都在聚焦新闻本身的时候，有没有想过，什么样的字体行为会受到侵权呢？ 在设计行业中，常见的微软雅黑字体侵权主要表现在线上的banner、广告、页面、电影等，线下的印刷品、户外广告、书籍等。各位设计师对这些都非常清楚：无版权，不可商用。 UI前端和微软雅黑 但是在UI设计这块，我们在电脑网页中显示的微软雅黑有版权吗？公司官网显示的文章字体都是微软雅黑，这样会侵权吗？我们再回顾下微软雅黑的历史。 “微软雅黑”字体是“北大方正电子有限公司”设计开发的字体作品。该字体与著名的“方正兰亭黑系列字体”（该系列字体共有十一个不同粗细版本，共十一款字体）系出同源，前者针对屏幕显示，后者针对印刷用。方正公司拥有“方正兰亭黑系列字体”的全部版权。但微软雅黑的版权分为两个部分，在Windows系统的内嵌使用，包括屏幕输出和个人使用为目的的打印，这部分微软已经向方正支付了版权授权费用，所有正版Windows用户均可放心使用。但是以商业发布为目的的微软雅黑版权，仍由北大方正保留。 微软公司在开发新一代操作系统时，为了改善屏幕字体的视觉效果，委托方正公司设计两款字体。微软公司将此两款字体命名为“微软雅黑”和“微软雅黑 Bold”。 这里我们可以看到一个关键词“屏幕输出”，即电脑屏幕上显示和我们关系最大。设计师设计完网页之后，前端需要进行代码制作，这时候使用的微软雅黑字体，其实就是属于屏幕输出。 如果要深入搞清楚这个，我们就要了解网页中是如何显示字体的。前端网页字体的定义主要有两种方式：font-family和@font-face。关于这些前端基础知识，各位UI设计师必须要了解下。 font-family font-family属于前端css属性中最基础...
阅读全文

使用 supervisor 管理进程

发布于
Supervisor ( http://supervisord.org ) 是一个用 Python 写的进程管理工具，可以很方便的用来启动、重启、关闭进程（不仅仅是 Python 进程）。除了对单个进程的控制，还可以同时启动、关闭多个进程，比如很不幸的服务器出问题导致所有应用程序都被杀死，此时可以用 supervisor 同时启动所有应用程序而不是一个一个地敲命令启动。 安装 Supervisor 可以运行在 Linux、Mac OS X 上。如前所述，supervisor 是 Python 编写的，所以安装起来也很方便，可以直接用 pip : sudo pip install supervisor 如果是 Ubuntu 系统，还可以使用 apt-get 安装。 supervisord 配置 Supervisor 相当强大，提供了很丰富的功能，不过我们可能只需要用到其中一小部分。安装完成之后，可以编写配置文件，来满足自己的需求。为了方便，我们把配置分成两部分：supervisord（supervisor 是一个 C/S 模型的程序，这是 server 端，对应的有 client 端：supervisorctl）和应用程序（即我们要管理的程序）。 首先来看 supervisord 的配置文件。安装完 supervisor 之后，可以运行 echo_supervisord_conf 命令输出默认的配置项，也可以重定向到一个配置文件里： echo_supervisord_conf > /etc/supervisord.conf 去除里面大部分注释和“不相关”的部分，我们可以先看这些配置： [unix_http_server] file=/tmp/supervisor.sock ; UNIX socket 文件，supervisorctl 会使用 ;chmod=0700 ; socket 文件的 mode，默认是 0700 ;chown=nobody:nogroup ; socket 文件的 owner，格式： uid:gid ;[inet_http_server] ; HTTP 服务器，提供 web 管理界面 ;port=127.0.0.1...
阅读全文

Blogger搭建国内可正常访问博客（超详细教程）

发布于
二、国内访问 Blogger 1 首先准备 请确认自己能够科学上网。 不会的话，我这里写有一篇教程： http://mooc1.chaoxing.com/zt/201723393.html 购买域名。没什么好讲的，各个地方都能买，我图便利，直接在阿里云买的域名。（同一个域名，在腾讯云买还要便宜点，不过因为我上一个域名就在阿里云买的，所以这次顺便就在阿里云买了） 2.设置解析 1.Blogger要求的设置 打开Blogger后台，找到设置—基本，Blogger 会提示你需要设置两个 CNAME 分别解析到 ghs.google.com 和 ***.dv.googlehosted.com (每一个人的都不一样) 为了 Blogger 可以在国内访问，我们不能直接按上述的解析。 我们得将第一个 CNAME 解析：记录类型： A 记录，主机记录：WWW，记录值由「ghs.google.com」改成 「国内可访问的 IP」 后面的一个CNAME 解析不变：记录类型：CNAME，主机记录：ai76xxxxxxxxxxx，记录值：gv-j5jxxxxxxxxxx 2. 寻找国内可访问的 IP 可以使用站长之家 Ping 工具：http://ping.chinaz.com/ 如下图所示，Ping检测：ghs.google.com 找一个国内可访问的 IP。 注意：香港的IP延迟虽然小，但是不行。 3.域名后台设置解析 打开阿里云控制台—域名—域名列表—解析，照第一步所说的那样样设置，如下图： 至此，域名解析设置完成，当然这样还不够，我们还得修改Blogger自带的博客模板。 备注：如果想要实现不带www访问 添加：记录类型： A 记录，主机记录：@，记录值同为找到的 「国内可访问的 IP」 如下图这样： 这样用 axutongxue.com 也可以访问我的博客了 4.启用https 之前大佬说在设置https时，不能直接设置： https://blog.iljw.me/2018/07/enable-blogger-https.html 不过现在blogger好像改了，按上面那样设置之后，我们就可以直接在Blogger后台开启https了 ...
阅读全文

微信小程序小总结

发布于
微信小程序使用起来感觉像写h5一样，对于新手估计会有比较多疑惑，如果撇去这些想法应该是很快就能上手的一套开发方案。 但是它自身的限制也比较大，如不提供window对象会导致一些功能实现起来比较麻烦。我这次开发的小程序就遇到了，虽然比较快找到解决办法（可能都是比较标准化的东西），希望之后不会有其他大坑。 需要其实比较简单，就是两页文章列表及文章详情页，刚上手却遇到下面的坑： 无法利用window对象解析xml 不支持HTML标签的使用 怎样兼容Promise和generator异步 刚开始一脸懵逼...后来赶紧去github看看各大牛例子及一些工具就解决了。 解析xml问题 由于比较多的解析插件都是基于 window.DOMParser 处理的，在小程序却无用武之地。找到问题就好解决，我要的是 DOMParser 而不是window找找应该有代替品，然后找到这个 xmldom 引入代替掉 DOMParser 就解决，然后把xml转成json处理了。 评论有问道如何改，这里我已经把这个整合到 这库 了。 解析html问题 现在比较成熟的是 wxParse 这货，的确大部分的html标签均能解析渲染，但是我这边程序录入的富文本内容却掺杂了些奇奇怪怪的标签，解析时还是会出错，内容解析到一半就停了...既然它做不到忽略，咋整？那把那些垃圾都过滤掉吧！！！马上用上 js-xss 这个来处理问题，能控制过滤的标签及标签能拥有的属性，方便得很。 const xss = require ( '../lib/js-xss/xss' ) const WxParse = require ( '../../lib/wxParse/wxParse.js' ) //把style及class添加到白名单。 Object .keys(xss.whiteList).forEach( name => xss.whiteList[name] = xss.whiteList[name].concat([ 'style' , 'class' ])) let content = xss( '<div>HTML文本</div>' , ...
阅读全文

Scrum实践指南：一个可运行的 Scrum是怎样的

发布于
Scrum需要实践和专注，只有持续不断地付出努力，才能达到新的状态。 在目前的互联网公司，敏捷（Agile）的概念已经有相当的普及，人人都在谈，似乎不谈敏捷就不那么互联网了。几乎所有的互联网公司都不同程度的实施了敏捷。 采用敏捷开发的方法也有很多，主要包括极限编程（XP）、Scrum、水晶方法（Crystal Methods）、自适应软件开发（ASD）、特性驱动开发（FDD）、动态系统开发（DSDM）、轻量级RUP、测试驱动开发（TDD）等等。而在众多的敏捷开发方法中，尤以实施Scrum比较流行。 对于我本人来说，接触Scrum有几年的时间了。在软件开发项目中做了一些Scrum的实践，闲暇时间也经常与业界Scrum同仁们沟通交流一些心得；同时，也始终在关注业界对于Scrum的一些新的认识和实践的书籍材料。在这一过程中，也促使我对Scrum有了更深刻的理解。 结合我的Scrum实践， 本文主要从Scrum的认识，Scrum的实施过程以及实施Scrum带来的变化几个方面进行分享，解读一个可运行的 Scrum是怎样的。 希望能给大家带来不一样的认识，并对Scrum实践有所帮助。 一、Scrum的认识 首先来了解一下Scrum的定义。 Scrum 是一个用于开发和维护复杂产品的框架，是一个增量的、迭代的开发过程。 在这个框架中，整个开发过程由若干个短的迭代周期组成，一个短的迭代周期称为一个Sprint，每个Sprint的长度是2到4周。 在Scrum中，使用产品Backlog来管理产品的需求。产品backlog按照实现的优先级进行排序，以商业价值作为排序的主要原则。在Sprint中，Scrum团队从产品Backlog中挑选最高优先级的需求进行开发。挑选的需求在Sprint计划会议上经过讨论、分析和估算得到相应的任务列表，称它为Sprint backlog。当Scrum团队完成Sprint backlog列表中的所有任务时，本次Sprint结束，进入下一个Sprint迭代周期。 Scrum有很大的价值，然而在有些公司推行Scrum却困难重重，有些人说Scrum没有什么实质性的作用，然并卵。为什么会有这样的认识呢？深入分析，原因主要有： 项目团队缺乏对敏捷的正确认识，单纯的认为敏捷就是快，就是追赶进度,就可以不受任何制度约束。大家可能听说过这样的对联，...
阅读全文