From 4fc5fc0bde917eb5bfda905351ec7a89ea160be3 Mon Sep 17 00:00:00 2001
From: Hsy <32729842@qq.com>
Date: Wed, 18 Dec 2024 14:19:21 +0800
Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0README.md=E6=96=87=E4=BB=B6?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 2dd61ae..b88753d 100644
--- a/README.md
+++ b/README.md
@@ -86,6 +86,18 @@ GOPROXY=https://goproxy.cn/,direct go install github.com/devttl/goctl-swagger@la
     goctl api plugin -plugin goctl-swagger="swagger -filename user.json" -api user.api -dir .
     ```
 
+* -pack 开启外层响应包装并指定外层响应结构名称
+
+    ```bash
+    goctl api plugin -plugin goctl-swagger='swagger -filename user.json -pack Response' -api user.api -dir .
+    ```
+
+- 使用 -response指定相应结构
+
+  ```bash
+goctl api plugin -plugin goctl-swagger='swagger -filename user.json -pack Response -response "[{\"name\":\"trace_id\",\"type\":\"string\",\"description\":\"链路追踪id\"},{\"name\":\"code\",\"type\":\"integer\",\"description\":\"状态码\"},{\"name\":\"msg\",\"type\":\"string\",\"description\":\"消息\"},{\"name\":\"data\",\"type\":\"object\",\"description\":\"数据\",\"is_data\":true}]";' -api user.api -dir .
+    ```
+
 * 指定Host，basePath，schemes [api-host-and-base-path](https://swagger.io/docs/specification/2-0/api-host-and-base-path/)
 
     ```shell script
@@ -107,4 +119,4 @@ GOPROXY=https://goproxy.cn/,direct go install github.com/devttl/goctl-swagger@la
       -l "$l" \
       -o "/go-work/clients/$l"
   done
-   ```
+  ```