首页
学习
活动
专区
圈层
工具
发布

接口文档如何去写?

自动生成接口文档 设置接口文档路径 文档描述说明的定义位置 配置文件 访问接口文档网页 两点说明: 如何写好接口文档 HTTP携带信息的方式 分离通用信息 路径中的参数表达式 数据模型定义 请求示例 异常处理...安装:pip install coreapi 设置接口文档路径 文档路由对应的视图配置为rest_framework.documentation.include_docs_urls 参数title为接口文档网站的标题...路径中的参数表达式 URL中参数表达式使用mustache的形式,参数包裹在双大括号之中`` 例如: /api/user/ /api/user/?...以为HTTP传输的数据往往都需要序列化,大部分数据类型都是字符串。一些特殊的类型,例如枚举类型的字符串,可以在说明里描述。 另外:数据模型非常建议使用表格来表现。 举个栗子?...markdown文档有以下缺点: 文档的表现形式非常依赖文档查看器:各个版本的word文档对word的表现形式差异很大,可能在你的电脑上内容表现很好的文档,到别人的电脑上就会一团乱麻;另外markdown文件也是如此

1.7K10

REST API设计指导——译自Microsoft REST API Guidelines(四)

关于REST API的书籍很多,但是完整完善实践丰富的设计指导并不多见,我们有幸看到了微软团队的作品——Microsoft REST API Guidelines,因此才有了此篇内容。...PS:Gzip, deflate 是常用的HTPP压缩方式,对于REST API,也是可以支持HTTP动态压缩的。不过如果数据量比较大,压缩会比较消耗CPU资源。所以对于大数据,请慎重。...Accept-Language | "en", "es", etc. |Specifies the preferred language for the response....Accept-Language | en,es,etc | 指定响应的首选语言。服务不要求必须支持,但是如果服务支持本地化,它必须通过Accept-Language来指定语言。...Prefer  | 返回=极小值 ,返回=代表事物 | 如果指定了返回=最小优先级,则服务应响应成功插入或更新返回空主体。如果指定了Reale=表示,服务应该返回响应中创建的或更新的资源。

3K50
  • 您找到你想要的搜索结果了吗?
    是的
    没有找到

    手把手教你用Python脚本调用 DeepL API Pro 进电子书的行进行中英文自动翻译

    四、选择 html 格式作为翻译格式的原因 可以保留书中大量的脚注、尾注及其链接;DeepL 有专门的 API 参数处理 xml tag,tag_handling="xml"; 可以通过 css 文件随意设置显示样式...返回的译文非常规整,能够保留所有 html tag;并且,“返回字符串” 与 “原字符串” 相同,可以作为一个判断依据 —— 该行有没有被翻译,如果没有,在生成的译文 html 文件中,该行没必要重复出现...API Pro target_language = "ZH" ## 当然,你可以将目标语言设置成任何 DeepL 支持的语言 path = "John Law/" # 文件夹名称末尾得有 / source_filename...except: succeeded = False if line.strip() == line_translated.strip(): #返回的字符串与原字符串相同...这篇文章主要给大家介绍了使用Python脚本调用DeepL API Pro进电子书的行中英文自动翻译的方法,代码亲测可行,欢迎大家积极尝试,下次再遇到需要自动翻译的时候,不妨调用下这个API,兴许事半功倍呢

    2.8K30

    一文学懂 TypeScript 的类型

    ]> 函数类型 以下是函数类型的例子: 1(num: number) => string 这个类型是一个函数,它接受一个数字类型参数并且返回值为字符串。...{ 2 const num = 123; 3 return callback(num); 4} 特殊返回值类型 void void 是函数的特殊返回值类型:它告诉 TypeScript 函数总是返回...Optional 与 `undefined|T` 类型为 T 的可选参数和类型为 undefined|T 的参数非常相似。 (另外对于可选属性也是如此。)...所有属性键(字符串和/或符号)都具有相同的类型,属性值也是如此。 我们将在本文章中忽略 object-as-dictionaries。顺便说一句,无论如何,map 通常是比字典的更好选择。...【https://tc39.github.io/ecma262/#sec-ecmascript-language-types】 “TypeScript 手册”:写得非常好,并解释了TypeScript支持的各种其他类型和类型的运算符

    2.4K41

    如何用R和API免费获取Web数据?

    即便你已经掌握了数据分析的十八般武艺,没有数据也是苦恼的事情。“拔剑四顾心茫然”说的大概就是这种情境吧。 数据的来源有很多。Web数据是其中数量庞大,且相对容易获得的类型。...维基百科专门为我们提供了一类数据,叫做度量数据(metrics),其中就涵盖了页面访问次数这个关键值。对应API的介绍页面,在这里。 ? 页面里有一个样例。...恭喜你,这就是我们需要获得的数据了。只不过,它使用了一种特殊的数据格式,叫做JSON。 JSON是目前互联网上数据交互的主流格式之一。如果你想搞清楚JSON的含义和用法,可以参考这个教程。...数据能够正常返回,下面我们在RStudio中采用语句方式来调用。 注意下面的代码中,程序输出部分的开头会有##标记,以便和执行代码本身相区别。 一上来,我们就需要设置一下时区。...starting <- "20171001" ending <- "20171003" article_title <- "Yes Minister" 根据已经设定的参数,我们就可以生成调用的API地址了

    3K20

    带你认识 flask ajax 异步请求

    两者都是付费服务,但微软为低频少量的翻译提供了免费的入门级选项。谷歌过去提供免费翻译服务,但现在,即使是最低层次的服务也需要付费。...return json.loads(r.content.decode('utf-8-sig')) 该函数定义需要翻译的文本、源语言和目标语言为参数,并返回翻译后文本的字符串。...它首先检查配置中是否存在翻译服务的Key,如果不存在,则会返回错误。错误也是一个字符串,所以从外部看,这将看起来像翻译文本。这可确保在出现错误时用户将看到有意义的错误消息。...为了生成引用这个图像的URL,我使用url_for()函数,传递特殊的路由名称static并给出图像的文件名作为参数。...如果你在环境中设置了有效的Microsoft Translator API Key,则现在应该能够触发翻译。假设你的浏览器设置为偏好英语,则需要使用其他语言撰写文章以查看“翻译”链接。

    5.3K20

    Python爬虫之Splash详解

    即使不懂这个语言的语法,但从脚本的表面意思,我们也可以大致了解到它首先调用 go 方法去加载页面,然后调用 wait 方法等待了一定时间,最后返回了页面的源码、截图和 HAR 信息。...Splash", ["Site"] = "Splash", }) splash:go("http://httpbin.org/get") return splash:html() end 在这里我们设置了...其实 Splash 给我们提供了一些 HTTP API 接口,我们只需要请求这些接口并传递相应的参数即可获取页面渲染后的结果,下面我们对这些接口进行介绍: render.html 此接口用于获取 JavaScript...另外此接口还支持代理设置、图片加载设置、Headers 设置、请求方法设置,具体的用法可以参见官方文档:Splash HTTP API — Splash 3.5 documentation。...还有更多参数设置可以参考官方文档:Splash HTTP API — Splash 3.5 documentation。 execute 此接口才是最为强大的接口。

    1.5K11

    .NET Core使用微软AI认知服务识别文字语言

    .NET Core 调用认知服务 Azure认知服务提供了REST接口,所以我们在.NET Core里可以像使用任何REST API一样,构造请求,并解析返回的JSON字符串。...DetectResult类型也是我们自己定义的,它的定义稍后再看。...使用POST动作向认知服务的终端地址提交一个构造的Body,内容Text为方法的输入参数,即要识别的文字。API的认证方式使用SubscriptionKey。...假设识别的是简体中文,并且没有发生异常,那么Azure认知服务的返回Json会是这样: [ { "language": "zh-Hans", "score": 1.0...我根据Azure认知服务可能返回的两种情况:成功、失败,构造了DetectResult类型: public class DetectResult { public string RawJson

    1.3K10

    ElasticSearch,枯燥的基础知识讲完啦!该上 Java 客户端了!

    学习 Java API 的意义在于,它帮我们将很多操作封装成了 API,不用自己再去手动拼 JSON 字符串了,也不用手动解析字符串了,这是它的方便之处。...如果不用 Java API 的话,请求参数 JSON、响应 JSON 都需要我们手动去拼接并解析,简单的 JSON 字符串还好,复杂的 JSON 字符串就很头大了。...Spring Data Elasticsearch 其实也是如此,它底层封装的就是官方的客户端 Java High Level REST Client,这个我们从它的依赖关系中就可以看出来: ?...这个所谓的高级客户端它的内部其实还是基于低级客户端,只不过针对 ElasticSearch 它提供了更多的 API,将请求参数和响应参数都封装成了相应的 API,开发者只需要调用相关的方法就可以拼接参数或者解析响应结果...Java High Level REST Client 中的每个 API 都可以同步或异步调用,同步方法返回一个响应对象,而异步方法的名称则以 Async 为后缀结尾,异步请求一般需要一个监听器参数,用来处理响应结果

    2.5K00

    Microsoft REST API指南

    如:实现或必须与某些外部定义的REST API互操作的REST服务必须与哪些外部的API兼容,而无法遵循这些准则。而还有一些服务也可能具有需要特殊性能需求,必须采用其他格式,例如二进制协议。...[*]译者注:错误可以理解成客户端参数错误,通常返回“4XX”状态码,并不影响整体的API使用。...Accept-Language “en”, “es”, etc. 指定响应的首选语言。不需要服务来支持这一点,但是如果一个服务支持本地化,那么它必须通过Accept-Language头来支持本地化。...如果设置了“withCredentials”属性,XmlHttpRequest将仅在跨域请求上发送cookie; 这也会导致预检请求。...该属性由_$orderBy_查询参数的值确定。 $orderBy 参数的值包含用于对项目进行排序表达式列表,用逗号分隔的。 这种表达式的特殊情况是属性路径终止于基本属性。

    6.2K11

    接口设计技巧和最佳实践

    ,同一个字段中不应该混合多种类型数据 4、始终返回所有的字段 不要删除字段属性,即使值为空 5、不要滥用JSON对象 API中的每个JSON对象应该始终在请求之间具有不可变性...,服务器可以定义响应结果的缓存时长设置 13、为你的接口实现限流 API确实实施了速率限制的话,请务必通过响应提供其当前状态来告知你的调用者 14、考虑让你的接口返回支持字段过滤...保持客户端同步一个比较好的办法是使用before_id和after_id参数组合,比如客户端将已知的最新条目的id作为after_id请求参数,然后检索之后创建的新条目 16、接口异常显式返回...RPC调用中Exception应该也是返回值的一部分,应该设计成Checked Exception,尽量让调用方能够显式的处理 17、接口使用Specification规格模式 设计者应该避免太多...] https://medium.com/epignosis-engineering/rest-api-development-tips-and-best-practices-part-1-9cbd4b924285

    1.7K60

    Langchain 和 RAG 最佳实践

    GPU限制:参数超过10亿的GPT模型,前向传播无法处理如此大的参数,因此分割是必要的。 计算更高效。 某些模型有固定的序列长度限制。 更好的泛化能力。...字符文本分割器与递归字符文本分割器示例 完整代码可在这里查看。...当用户查询时,查询会被嵌入,然后找到最相似的向量,即这些块的索引,然后返回这些块。 实践 嵌入 完整代码可在这里查看。 首先安装库: chromadb是一个轻量级向量数据库。...embeddings = ZhipuAIEmbeddings( model="embedding-3", api_key="你的api key" ) # 设置持久化目录 persist_directory...1.0.3 documentation'} # Document 2 metadata: {'language': 'en', 'source': 'https://en.d2l.ai/', 'title

    77900

    使用 pyhttptest 轻松测试 REST API

    使用 pyhttptest 轻松测试 REST API 现在,我们每个人都面临着 REST API,要么开发这样的服务,要么使用这样的服务。...": "en-US"   } } ---- 发送 HTTP POST 请求 json文件内容如下 {   "name": "TEST: Create an HTML bin",   "verb": "POST.../v1/users",     "host": "http://localhost:8085/",     "headers": {       "Accept-Language": "en-US"     ...所有的 HTTP 报头 query_string - 查询字符串-在问号后面的 URL 中的查询字符串参数 payload - 数据 Tips 您可能会想到一个问题,如何将测试用例添加、结构和组织到我现有的...在新目录中,可以将所有json文件,定义了 API 测试用例的文件。 通过这样做,您的测试将很容易区分。

    1.2K30
    领券