简体   繁体   中英

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. I need the API documentation to indicate the need for the x-auth-token header with the value of the previously obtained token. How to do it?

In the end, I chose a simpler and more understandable library for API documentation - apidocjs. Another library that I also liked is OpenAPI

The technical post webpages of this site follow the CC BY-SA 4.0 protocol. If you need to reprint, please indicate the site URL or the original address.Any question please contact:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM