（1）修正参数的设置顺序

（2）修复部分 Bug

demo/controller/AnnouncementController.js

@@ -0,0 +1,14 @@
+// @flow
+
+import AnnouncementControllerDoc from "./AnnouncementControllerDoc";
+import {apiDescription, apiRequestMapping} from "../../src/swagger/decorator";
+import AnnouncementInterfaceEntity from "../entity/AnnouncementInterfaceEntity";
+
+export default class AnnouncementController extends AnnouncementControllerDoc {
+  @apiRequestMapping(
+    "get",
+    "/announcements/:column_code/:menu_code/:category_code"
+  )
+  @apiDescription("根据目录结构获取公告列表信息。")
+  static async getAnnouncements(ctx, next): [AnnouncementInterfaceEntity] {}
+}

demo/controller/AnnouncementControllerDoc.js

@@ -0,0 +1,8 @@
+// @flow
+
+import AnnouncementInterfaceEntity from "../entity/AnnouncementInterfaceEntity";
+import { apiResponse } from "../../src/swagger/decorator";
+export default class AnnouncementControllerDoc {
+  @apiResponse(200, "get users successfully", [AnnouncementInterfaceEntity])
+  static async getAnnouncements(ctx, next): [AnnouncementInterfaceEntity] {}
+}

demo/controller/UserController.js

@@ -15,7 +15,6 @@ import UserControllerDoc from "./UserControllerDoc";
  * Description 用户相关控制器
  */
 export default class UserController extends UserControllerDoc {
-
   @apiRequestMapping("get", "/users")
   @apiDescription("get all users list")
   static async getUsers(ctx, next): [User] {

demo/controller/UserControllerDoc.js

@@ -17,7 +17,8 @@ export default class UserControllerDoc {
   @pathParameter({
     name: "id",
     description: "user id",
-    type: "integer"
+    type: "integer",
+    defaultValue: 1
   })
   @queryParameter({
     name: "tags",

demo/entity/AnnouncementInterfaceEntity.js

@@ -0,0 +1,39 @@
+// @flow
+
+import { entityProperty } from "../../src/entity/decorator";
+
+/**
+ * Description 公告列表实体类
+ */
+export default class AnnouncementInterfaceEntity {
+  // 数据
+  @entityProperty({
+    type: "JSON",
+    description: "字段及数据",
+    required: true
+  })
+  meta: Object = [];
+
+  // 数据
+  @entityProperty({
+    type: "JSON",
+    description: `数据示例：
+      [
+        {
+          title: "（雨花区）雨花西路244号小区整治出新工程施工",
+          uuid: "ab7ed1171491496b54f78ee8e5be3ce4",
+          announce_date: "2017-07-06T16:00:00.000Z",
+          properties: [
+            "雨花西路244号小区整治出新工程",
+            "施工",
+            "AYH170230-01SG",
+            "201.70",
+            "2017-07-07"
+          ]
+        }
+      ]
+    `,
+    required: false
+  })
+  data: Object = [];
+}

demo/router.js

@@ -3,7 +3,8 @@
  */
 
 import UserController from "./controller/UserController";
-import {wrappingKoaRouter} from "../src/transform/koa_router";
+import { wrappingKoaRouter } from "../src/transform/koa_router";
+import AnnouncementController from "./controller/AnnouncementController";
 const Router = require("koa-router");
 
 const router = new Router();
@@ -22,6 +23,7 @@ router.get("/", async function(ctx, next) {
 
 //定义用户处理路由
 router.scan(UserController);
+router.scan(AnnouncementController);
 
 //默认导出路由配置
 export default router;

package.json

@@ -1,12 +1,13 @@
 {
   "name": "swagger-decorator",
-  "version": "0.0.12",
+  "version": "0.0.17",
   "description": "Decorator for Koa2 and koa-router, Auto-Generate Swagger Docs",
   "main": "dist/index.js",
+  "browser": "dist/index.browser.js",
   "scripts": {
     "start": "./node_modules/.bin/nodemon --exec 'babel-node' './demo/app.js' --watch './src' --watch './demo'",
     "prepublish": "npm run build",
-    "build": "node_modules/babel-cli/bin/babel.js src --out-dir dist",
+    "build": "rm -rf dist && node_modules/babel-cli/bin/babel.js src --out-dir dist",
     "test": "jest"
   },
   "repository": {
@@ -52,6 +53,7 @@
     "nodemon": "^1.11.0"
   },
   "dependencies": {
-    "path-to-regexp": "^1.7.0"
+    "path-to-regexp": "^1.7.0",
+    "sequelize": "^4.2.1"
   }
 }

src/entity/decorator.js

@@ -12,6 +12,16 @@ export function generateEntityUUID(target, key, descriptor) {
   return target.constructor.name;
 }
 
+/**
+ * Description 为某个类加上注解，并且创建新的对象以触发内部迭代注解
+ * @param Class
+ * @returns {*}
+ */
+export function entity(Class) {
+  new Class();
+  return Class;
+}
+
 /**
  * Description 创建某个属性的描述
  * @param type 基础类型 self - 表示为自身

src/index.browser.js

@@ -0,0 +1,4 @@
+// @flow
+
+export { entityProperty } from "./entity/decorator";
+export { innerEntityObject } from "./singleton";

src/index.js

@@ -1,35 +1,14 @@
 // @flow
 
-import {
-  apiRequestMapping as _apiRequestMapping,
-  apiDescription as _apiDescription,
-  bodyParameter as _bodyParameter,
-  pathParameter as _pathParameter,
-  queryParameter as _queryParameter,
-  apiResponse as _apiResponse
+export {
+  apiRequestMapping,
+  apiDescription,
+  bodyParameter,
+  pathParameter,
+  queryParameter,
+  apiResponse
 } from "./swagger/decorator";
-import { entityProperty as _entityProperty } from "./entity/decorator";
-import { wrappingKoaRouter as _wrappingKoaRouter } from "./transform/koa_router";
-import {
-  generateSequelizeModel as _generateSequelizeModel
-} from "./transform/sequelize";
-import {
-  innerAPIObject as _innerAPIObject,
-  innerEntityObject as _innerEntityObject
-} from "./singleton";
-
-export const innerAPIObject = _innerAPIObject;
-export const innerEntityObject = _innerEntityObject;
-
-export const apiRequestMapping = _apiRequestMapping;
-export const apiDescription = _apiDescription;
-export const bodyParameter = _bodyParameter;
-export const pathParameter = _pathParameter;
-export const queryParameter = _queryParameter;
-export const apiResponse = _apiResponse;
-
-export const entityProperty = _entityProperty;
-
-export const wrappingKoaRouter = _wrappingKoaRouter;
-
-export const generateSequelizeModel = _generateSequelizeModel;
+export { entityProperty } from "./entity/decorator";
+export { wrappingKoaRouter } from "./transform/koa_router";
+export { generateSequelizeModel } from "./transform/sequelize";
+export { innerAPIObject, innerEntityObject } from "./singleton";

src/swagger/decorator.js

@@ -57,16 +57,19 @@ export function apiDescription(
  * @param name
  * @param description
  * @param type
+ * @param defaultValue
  * @returns {Function}
  */
 export function pathParameter({
   name,
   description,
-  type
+  type,
+  defaultValue
 }: {
   name: string,
   description: string,
-  type: string
+  type: string,
+  defaultValue: any
 }) {
   return function(target, key, descriptor) {
     let apiKey = `${target.name}-${key}`;
@@ -76,12 +79,13 @@ export function pathParameter({
     innerAPIObject[apiKey].pathParameter ||
       (innerAPIObject[apiKey].pathParameter = []);
 
-    innerAPIObject[apiKey].pathParameter.push({
+    innerAPIObject[apiKey].pathParameter.splice(0, 0, {
       name,
       description,
       type,
       in: "path",
-      required: true
+      required: true,
+      default: defaultValue
     });
 
     return descriptor;
@@ -95,14 +99,16 @@ export function pathParameter({
  * @param required
  * @param type
  * @param items
+ * @param defaultValue
  * @returns {Function}
  */
 export function queryParameter({
   name,
   description,
   required,
   type,
-  items
+  items,
+  defaultValue
 }: {
   name: string,
   description: string,
@@ -118,13 +124,14 @@ export function queryParameter({
     innerAPIObject[apiKey].queryParameter ||
       (innerAPIObject[apiKey].queryParameter = []);
 
-    innerAPIObject[apiKey].queryParameter.push({
+    innerAPIObject[apiKey].queryParameter.splice(0, 0, {
       name,
       description,
       required,
       type,
       items,
-      in: "query"
+      in: "query",
+      default: defaultValue
     });
 
     return descriptor;
@@ -158,7 +165,7 @@ export function bodyParameter({
     innerAPIObject[apiKey].bodyParameter ||
       (innerAPIObject[apiKey].bodyParameter = []);
 
-    innerAPIObject[apiKey].bodyParameter.push({
+    innerAPIObject[apiKey].bodyParameter.splice(0, 0, {
       name,
       description,
       required,
@@ -192,7 +199,7 @@ export function apiResponse(
 
     innerAPIObject[apiKey].responses || (innerAPIObject[apiKey].responses = []);
 
-    innerAPIObject[apiKey].responses.push({
+    innerAPIObject[apiKey].responses.splice(0, 0, {
       statusCode,
       description,
       schema

src/swagger/definitions.js

@@ -8,6 +8,11 @@ import { innerEntityObject } from "../singleton";
  * @private
  */
 export function buildDefinitions(Class: any) {
+  // 为了避免部分情况下传入的是 Class 数组，因此首先进行递归处理
+  while (Array.isArray(Class)) {
+    Class = Class[0];
+  }
+
   // 初始化 Swagger JSON 中的 definitions 字段
   swaggerJSON["definitions"] || (swaggerJSON["definitions"] = {});
 
@@ -39,13 +44,14 @@ export function buildDefinitions(Class: any) {
 
       let realType = originType[0];
 
-      property.items = typeof realType === "function"
-        ? {
-            $ref: `#/definitions/${originType[0].name}`
-          }
-        : {
-            type: `${originType[0]}`
-          };
+      property.items =
+        typeof realType === "function"
+          ? {
+              $ref: `#/definitions/${originType[0].name}`
+            }
+          : {
+              type: `${originType[0]}`
+            };
     }
 
     // 如果为函数类型