Skip to content

Commit b552a95

Browse files
committed
fix: swagger
1 parent 18e4c45 commit b552a95

3 files changed

Lines changed: 9 additions & 6 deletions

File tree

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -117,14 +117,15 @@ Lin 的服务端框架是基于 Python Flask 的,所以如果您比较熟悉 F
117117
打开您的命令行工具(terminal),在其中键入:
118118

119119
```bash
120-
git clone https://github.com/TaleLin/lin-cms-flask.git starter
120+
git clone https://github.com/TaleLin/lin-cms-flask.git -b 0.3.x starter
121121
```
122122

123+
> **Tips:** 当前分支不是默认分支,所以需要分支切换到`0.3.x`
124+
>
123125
> 我们以 `starter` 作为工程名,当然您也可以以任意您喜爱的名字作为工程名。
126+
>
124127
> 如果您想以某个版本,如`0.0.1`版,作为起始项目,那么请在 github 上的版本页下载相应的版本即可。
125128
126-
> **Tips:** 切换到当前分支`git checkout 0.3.x`
127-
128129
### 安装依赖包
129130

130131
进入项目目录,调用环境中的 pip 来安装依赖包:
@@ -190,7 +191,9 @@ flask run
190191

191192
“心上无垢,林间有风"
192193

193-
这证明您已经成功的将 Lin 运行起来了,Congratulations!
194+
点击“心上无垢”,将跳转到`Redoc`页面;点击“林间有风”,跳转到`Swagger`页面。
195+
196+
这证明您已经成功的将服务运行起来了,Congratulations!
194197

195198
## 后续开发计划
196199

app/api/v1/book.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ def get_books():
5757
@book_api.route("/search", methods=["GET"])
5858
@lindoc.validate(
5959
query=BookQuerySearchSchema,
60-
resp=DocResponse(BookNotFound),
60+
resp=DocResponse(BookNotFound, http_200=BookListSchema),
6161
tags=["图书"],
6262
)
6363
def search():

app/validator/schema.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ class BookSchema(BaseModel):
7373

7474

7575
class BookListSchema(BaseModel):
76-
items: List[BookSchema] = list()
76+
items: List[BookSchema]
7777

7878

7979
class Language(str, Enum):

0 commit comments

Comments
 (0)