hehe

hehe.json

{"info":{"version":"1.0.0","description":"\n## \u5173\u4e8e\u63a5\u53e3\u8c03\u7528\n\u63a5\u53e3\u901a\u8fc7 http \u534f\u8bae\u8c03\u7528\u3002\u6240\u6709\u63a5\u53e3\u7684 http method \u5168\u90e8\u4e3a POST\u3002\u6240\u6709\u63a5\u53e3\u7684 http \u72b6\u6001\u7801\u5168\u90e8\u4e3a 200\uff08\u662f\u5426\u8c03\u7528\u6210\u529f\u53c2\u8003\u8fd4\u56de\u7684\u4e1a\u52a1\u72b6\u6001\u7801\uff09\u3002\u6240\u6709\u63a5\u53e3\u7684\u4e1a\u52a1\u53c2\u6570\u5e8f\u5217\u5316\u4e3a json \u5b57\u7b26\u4e32\uff0c\u901a\u8fc7 http body \u4f20\u9012\u3002\u9274\u6743\u53c2\u6570\u901a\u8fc7 http header \u4f20\u9012\n## \u5173\u4e8e api \u7b7e\u540d\u9274\u6743\n\u5bf9\u4e8e\u6240\u6709\u7684\u63a5\u53e3\u8c03\u7528\uff0c\u8c03\u7528\u65b9\u90fd\u9700\u8981\u6dfb\u52a0\u7b7e\u540d\u53c2\u6570\u3002\u5e73\u53f0\u4f1a\u4e3a\u8c03\u7528\u65b9\u751f\u6210 apiKey \u548c apiSecret\n\u7b7e\u540d\u76f8\u5173\u6570\u636e\u901a\u8fc7 http header \u4f20\u9012\u3002http header key \u5206\u522b\u4e3a\uff1a\n- X-XCF-OPENAPI-KEY \u5373\u4e3a\u4e0b\u53a8\u623f\u63d0\u4f9b\u7684 apiKey\n- X-XCF-OPENAPI-NONCE \u6700\u957f16\u5b57\u7b26\u7684\u968f\u673a\u5b57\u7b26\u4e32\uff0c\u5b57\u7b26\u8303\u56f4\u4e3a(a-z|A-Z|0-9)\n- X-XCF-OPENAPI-TS unix \u65f6\u95f4\u6233\uff0c\u5355\u4f4d\u4e3a\u79d2\n- X-XCF-OPENAPI-SIGN \u8ba1\u7b97\u540e\u7684\u7b7e\u540d\u3002\u8ba1\u7b97\u89c4\u5219\u4e3a\uff1aSHA1($HTTP_BODY + \"|\" + $TS + \"|\" + $NONCE + \"|\" + $API_SECRET)\uff0c\u5373\u5c06`http body \u503c` `header \u4e2d\u4f20\u5165\u7684\u65f6\u95f4\u6233` `header \u4e2d\u4f20\u5165\u7684\u968f\u673a\u5b57\u7b26\u4e32` `\u5e73\u53f0\u63d0\u4f9b\u7684 apiSecret` \u4ee5\"|\"\u95f4\u9694\u5e76\u4f9d\u6b21\u62fc\u63a5\uff0c\u8fdb\u884c sha1 \u54c8\u5e0c\uff0c\u5e76\u5c06\u54c8\u5e0c\u7ed3\u679c\u8f6c\u6362\u4e3a\u5927\u5199\u5b57\u6bcd\u5f62\u5f0f","title":"openapi document"},"paths":{"/category/list":{"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedCategoryReq"}}}},"description":null,"responses":{"success":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedCategoryResp"}}},"description":"http200 \u8bf7\u6c42\u6210\u529f"},"error":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultErrorResp"}}},"description":"http200 \u8bf7\u6c42\u5931\u8d25"}}}},"/top-list/list-recipe":{"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TopListPagedRecipeReq"}}}},"description":"\u5206\u9875\u67e5\u8be2\u699c\u5355\u7684\u83dc\u8c31","responses":{"success":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToplistPagedRecipeResp"}}},"description":"http200 \u8bf7\u6c42\u6210\u529f"},"error":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultErrorResp"}}},"description":"http200 \u8bf7\u6c42\u5931\u8d25"}}}},"/category/list-recipe":{"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryPagedRecipeReq"}}}},"description":"\u901a\u8fc7\u5206\u7c7b id \u5206\u9875\u67e5\u8be2\u83dc\u8c31","responses":{"success":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryPagedRecipeResp"}}},"description":"http200 \u8bf7\u6c42\u6210\u529f"},"error":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultErrorResp"}}},"description":"http200 \u8bf7\u6c42\u5931\u8d25"}}}},"/message/get":{"post":{"requestBody":{"content":{"application/json":{}}},"description":"\u83b7\u53d6\u73b0\u6709\u6d88\u606f","responses":{"success":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageCollectionResp"}}},"description":"http200 \u8bf7\u6c42\u6210\u529f"},"error":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultErrorResp"}}},"description":"http200 \u8bf7\u6c42\u5931\u8d25"}}}},"/message/mark-as-done":{"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageIDReq"}}}},"description":"\u5c06 id \u4e3a xxx \u524d\u7684\u6d88\u606f\u6807\u8bb0\u5220\u9664","responses":{"success":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultOkResp"}}},"description":"http200 \u8bf7\u6c42\u6210\u529f"},"error":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultErrorResp"}}},"description":"http200 \u8bf7\u6c42\u5931\u8d25"}}}}},"servers":[{"url":"https://openapi.xiachufang.com"}],"components":{"securitySchemes":{"apiTs":{"type":"apiKey","name":"X-XCF-OPENAPI-TS","in":"header"},"apiKey":{"type":"apiKey","name":"X-XCF-OPENAPI-KEY","in":"header"},"apiSign":{"type":"apiKey","name":"X-XCF-OPENAPI-SIGN","in":"header"},"apiNonce":{"type":"apiKey","name":"X-XCF-OPENAPI-NONCE","in":"header"}},"schemas":{"ToplistPagedRecipeResp":{"description":"","properties":{"status":{"enum":["ok"],"type":"string"},"content":{"type":"object","properties":{"has_next":{"type":"boolean","description":""},"recipes":{"items":{"type":"object","properties":{"category":{"items":{"type":"object","properties":{"url":{"type":"string","description":"\u5206\u7c7b url"},"id":{"type":"integer","description":"\u5206\u7c7b id"},"name":{"type":"string","description":"\u5206\u7c7b\u540d\u79f0"}},"description":"\u83dc\u8c31\u5206\u7c7b"},"type":"array","description":"\u83dc\u8c31\u5206\u7c7b"},"n_collects":{"type":"integer","description":"\u83dc\u8c31\u6536\u85cf\u6570"},"description":{"type":"string","description":"\u83dc\u8c31\u63cf\u8ff0"},"video_url":{"type":"string","description":"\u89c6\u9891\u83dc\u8c31\u89c6\u9891\u94fe\u63a5"},"ingredients":{"items":{"type":"object","properties":{"amount":{"type":"string","description":"\u6750\u6599\u7528\u6599"},"name":{"type":"string","description":"\u6750\u6599\u540d\u79f0"}},"description":"\u83dc\u8c31\u6750\u6599"},"type":"array","description":"\u83dc\u8c31\u6750\u6599"},"url":{"type":"string","description":"\u83dc\u8c31\u7f51\u9875\u94fe\u63a5"},"n_dishs":{"type":"integer","description":"\u83dc\u8c31\u4f5c\u54c1\u6570"},"author":{"type":"object","properties":{"name":{"type":"string","description":"\u7528\u6237\u6635\u79f0"},"pic_url":{"type":"string","description":"\u7528\u6237\u5934\u50cf\u56fe\u7247\u94fe\u63a5"}},"description":"\u83dc\u8c31\u4f5c\u8005"},"id":{"type":"integer","description":""},"n_comments":{"type":"integer","description":"\u83dc\u8c31\u8bc4\u8bba\u6570"},"create_time":{"type":"string","description":"\u83dc\u8c31\u521b\u5efa\u65f6\u95f4\n\n\u683c\u5f0f: YYYY-MM-DD hh:mm:ss"},"steps":{"items":{"type":"object","properties":{"step":{"type":"string","description":"\u6b65\u9aa4\u6587\u5b57\u63cf\u8ff0"},"pic_url":{"type":"string","description":"\u6b65\u9aa4\u56fe\u94fe\u63a5"},"video_url":{"type":"string","description":"\u6b65\u9aa4\u77ed\u89c6\u9891\u94fe\u63a5"}},"description":"\u83dc\u8c31\u6b65\u9aa4"},"type":"array","description":"\u83dc\u8c31\u6b65\u9aa4"},"tips":{"type":"string","description":"\u83dc\u8c31\u5c0f\u8d34\u58eb"},"score":{"type":"string","description":"\u83dc\u8c31\u8bc4\u5206"},"pic_url":{"type":"string","description":"\u5c01\u9762\u56fe\u94fe\u63a5"},"name":{"type":"string","description":"\u83dc\u8c31\u540d"}},"description":""},"type":"array","description":""},"next_cursor":{"type":"string","description":""},"name":{"type":"string","description":""},"description":{"type":"string","description":""}}}}},"CategoryPagedRecipeResp":{"description":"","properties":{"status":{"enum":["ok"],"type":"string"},"content":{"type":"object","properties":{"has_next":{"type":"boolean","description":""},"recipes":{"items":{"type":"object","properties":{"category":{"items":{"type":"object","properties":{"url":{"type":"string","description":"\u5206\u7c7b url"},"id":{"type":"integer","description":"\u5206\u7c7b id"},"name":{"type":"string","description":"\u5206\u7c7b\u540d\u79f0"}},"description":"\u83dc\u8c31\u5206\u7c7b"},"type":"array","description":"\u83dc\u8c31\u5206\u7c7b"},"n_collects":{"type":"integer","description":"\u83dc\u8c31\u6536\u85cf\u6570"},"description":{"type":"string","description":"\u83dc\u8c31\u63cf\u8ff0"},"video_url":{"type":"string","description":"\u89c6\u9891\u83dc\u8c31\u89c6\u9891\u94fe\u63a5"},"ingredients":{"items":{"type":"object","properties":{"amount":{"type":"string","description":"\u6750\u6599\u7528\u6599"},"name":{"type":"string","description":"\u6750\u6599\u540d\u79f0"}},"description":"\u83dc\u8c31\u6750\u6599"},"type":"array","description":"\u83dc\u8c31\u6750\u6599"},"url":{"type":"string","description":"\u83dc\u8c31\u7f51\u9875\u94fe\u63a5"},"n_dishs":{"type":"integer","description":"\u83dc\u8c31\u4f5c\u54c1\u6570"},"author":{"type":"object","properties":{"name":{"type":"string","description":"\u7528\u6237\u6635\u79f0"},"pic_url":{"type":"string","description":"\u7528\u6237\u5934\u50cf\u56fe\u7247\u94fe\u63a5"}},"description":"\u83dc\u8c31\u4f5c\u8005"},"id":{"type":"integer","description":""},"n_comments":{"type":"integer","description":"\u83dc\u8c31\u8bc4\u8bba\u6570"},"create_time":{"type":"string","description":"\u83dc\u8c31\u521b\u5efa\u65f6\u95f4\n\n\u683c\u5f0f: YYYY-MM-DD hh:mm:ss"},"steps":{"items":{"type":"object","properties":{"step":{"type":"string","description":"\u6b65\u9aa4\u6587\u5b57\u63cf\u8ff0"},"pic_url":{"type":"string","description":"\u6b65\u9aa4\u56fe\u94fe\u63a5"},"video_url":{"type":"string","description":"\u6b65\u9aa4\u77ed\u89c6\u9891\u94fe\u63a5"}},"description":"\u83dc\u8c31\u6b65\u9aa4"},"type":"array","description":"\u83dc\u8c31\u6b65\u9aa4"},"tips":{"type":"string","description":"\u83dc\u8c31\u5c0f\u8d34\u58eb"},"score":{"type":"string","description":"\u83dc\u8c31\u8bc4\u5206"},"pic_url":{"type":"string","description":"\u5c01\u9762\u56fe\u94fe\u63a5"},"name":{"type":"string","description":"\u83dc\u8c31\u540d"}},"description":""},"type":"array","description":""},"next_cursor":{"type":"string","description":""},"id":{"type":"integer","description":""},"name":{"type":"string","description":""}}}}},"MessageIDReq":{"description":"","properties":{"id":{"required":true,"type":"integer","description":""}}},"PagedCategoryReq":{"description":"","properties":{"cursor":{"default":null,"required":false,"type":"string","description":""},"size":{"default":20,"required":false,"type":"integer","description":"\u9ed8\u8ba4\u503c: 20\n\n\u6700\u5927\u503c: 60"}}},"DefaultErrorResp":{"description":"","properties":{"status":{"enum":["error"],"type":"string"},"msg":{"type":"string","description":"\u9519\u8bef\u63cf\u8ff0"},"code":{"type":"integer","description":"\u9519\u8bef\u7801"}}},"CategoryPagedRecipeReq":{"description":"","properties":{"cursor":{"default":null,"required":false,"type":"string","description":""},"id":{"required":true,"type":"integer","description":""},"size":{"default":20,"required":false,"type":"integer","description":"\u9ed8\u8ba4\u503c: 20\n\n\u6700\u5927\u503c: 40"}}},"MessageCollectionResp":{"description":"","properties":{"status":{"enum":["ok"],"type":"string"},"content":{"type":"object","properties":{"messages":{"items":{"type":"object","properties":{"message":{"type":"string","description":"\u6d88\u606f\u5185\u5bb9:\n- 1 \u83dc\u8c31\u521b\u5efa: '{\"recipe\": {...}}' recipe \u4e3a\u83dc\u8c31\u8be6\u60c5\u7ed3\u6784\n- 3 \u83dc\u8c31\u66f4\u65b0: '{\"recipe\": {...}}' recipe \u4e3a\u83dc\u8c31\u8be6\u60c5\u7ed3\u6784\n- 2 \u83dc\u8c31\u5220\u9664: '{\"recipe_id\": 1}'"},"create_time":{"type":"string","description":"\u683c\u5f0f: YYYY-MM-DD hh:mm:ss"},"message_type":{"type":"integer","description":"\u6d88\u606f\u7c7b\u578b\uff1a\n- 1: \u83dc\u8c31\u521b\u5efa\n- 3: \u83dc\u8c31\u66f4\u65b0\n- 2: \u83dc\u8c31\u5220\u9664"},"id":{"type":"integer","description":""}},"description":""},"type":"array","description":""}}}}},"TopListPagedRecipeReq":{"description":"","properties":{"cursor":{"default":null,"required":false,"type":"string","description":""},"name":{"required":true,"type":"string","description":"\u699c\u5355\u540d\u79f0\n\n\u9009\u503c\u8303\u56f4: \n- rising\n- classic\n- honor\n- hall\n- editor\n- video"},"size":{"default":20,"required":false,"type":"integer","description":"\u9ed8\u8ba4\u503c: 20\n\n\u6700\u5927\u503c: 40"}}},"PagedCategoryResp":{"description":"","properties":{"status":{"enum":["ok"],"type":"string"},"content":{"type":"object","properties":{"has_next":{"type":"boolean","description":""},"next_cursor":{"type":"string","description":""},"categories":{"items":{"type":"object","properties":{"id":{"type":"integer","description":"\u83dc\u8c31\u5206\u7c7b id"},"name":{"type":"string","description":"\u83dc\u8c31\u5206\u7c7b\u540d\u79f0"}},"description":""},"type":"array","description":""}}}}},"DefaultOkResp":{"description":"","properties":{"status":{"enum":["ok"],"type":"string"},"content":{"type":"object","properties":{}}}}}},"security":[{"apiTs":[],"apiKey":[],"apiSign":[],"apiNonce":[]}],"openapi":"3.0.0"}