docs: 完善文档

This commit is contained in:
Fu Diwei
2021-06-12 18:17:57 +08:00
parent 902b022dc0
commit 323f1d627a
7 changed files with 122 additions and 8 deletions

View File

@@ -0,0 +1,11 @@
### 如何快速找到需要调用的 API 模型类名 / 方法名?
---
本库提供的请求模型、响应模型和接口方法,三者均保持同名。
例如,预估覆盖人数的请求是 `EstimationGetRequest`,响应是 `EstimationGetResponse`,接口是 `ExecuteEstimationGetAsync()`。知道其中一个,其余两个就可以快速地推断出了。
再有,每个对象的命名与官方文档的接口地址大体保持一致。例如刚刚提到的预估覆盖人数,它的接口地址是 `[POST] /estimation/get`,将其中的反斜杠去掉、并以大驼峰命名法的方式调整它,就可以得到前文提到的几个对象了。
完整的模型定义可以参考项目目录下的 _src/SKIT.FlurlHttpClient.Wechat.Ads/Models_ 目录。