您如何记录 header 的强制存在？
[英]How do you document the mandatory presence of a header?
问题描述
I know, there is jsdoc documentation, but I could not find my answer there, so I apologize if my question seems stupid.
我知道，有 jsdoc 文档，但我在那里找不到我的答案，所以如果我的问题看起来很愚蠢，我深表歉意。 I need the API documentation to indicate the need for the x-auth-token header with the value of the previously obtained token.我需要 API 文档来表明需要x-auth-token header 和先前获得的令牌的值。 How to do it?怎么做？
1 个解决方案
解决方案1
0 2021-03-01 15:11:29
In the end, I chose a simpler and more understandable library for API documentation - apidocjs.最后，我为API文档选择了一个更简单易懂的库——apidocjs。 Another library that I also liked is OpenAPI我也喜欢的另一个库是 OpenAPI
声明:本站的技术帖子网页，遵循CC BY-SA 4.0协议，如果您需要转载，请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.
相关问题
如何更新猫鼬中的参考文件？ - How do you update a referenced document in mongoose?
如何将标题添加到wav文件？ - How do you add a header to wav file?
如何通过两个或多个强制子条件使用mongodb查找文档 - how to find a document with mongodb by two or more mandatory subcondtions
在保存单击时如何在KeystoneJS中更新文档？ - How do you update a document in KeystoneJS on save click?
如何在Mongoose中保存对另一个文档的引用？ - How do you save a reference to another document in Mongoose?
如何更新 mongodb 地图集中文档中的值？ - How do you update a value in a document in mongodb atlas?
如何将 Mongoose 文档转换为普通对象？ - How do you turn a Mongoose document into a plain object?
如何查找和更新文档数组中的对象 - How do you fin and update objects in a document's array
如何使用Apollo Server 2.0 Beta阅读身份验证标头 - How do you read auth header with Apollo Server 2.0 beta
如何使用更改流来查看 MongoDB 中具有特定文档 ID 的文档？ - How do you use change streams to watch a document with a specific document ID in MongoDB?
相关标签