openapi.json

{"components":{"requestBodies":{"StoryBookFilter":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"author_id":{"exclusiveMinimum":true,"format":"int64","minimum":1,"type":"integer"},"name":{"enum":["fo"],"maxLength":10,"minLength":10,"type":"string"},"page":{"exclusiveMaximum":true,"format":"uint","maximum":10000,"minimum":1,"type":"integer"},"page_size":{"default":20,"format":"uint","maximum":100,"minimum":1,"type":"integer"},"publish_date_gt":{"format":"int32","type":"integer"},"publish_date_lte":{"format":"int32","type":"integer"},"type":{"enum":["foo,bar","spam|egg"],"type":"string"}},"title":"StoryBookFilter","type":"object"}},"multipart/form-data":{"schema":{"properties":{"author_id":{"exclusiveMinimum":true,"format":"int64","minimum":1,"type":"integer"},"name":{"enum":["fo"],"maxLength":10,"minLength":10,"type":"string"},"page":{"exclusiveMaximum":true,"format":"uint","maximum":10000,"minimum":1,"type":"integer"},"page_size":{"default":20,"format":"uint","maximum":100,"minimum":1,"type":"integer"},"publish_date_gt":{"format":"int32","type":"integer"},"publish_date_lte":{"format":"int32","type":"integer"},"type":{"enum":["foo,bar","spam|egg"],"type":"string"}},"title":"StoryBookFilter","type":"object"}}}},"StoryBookFilterWithBody":{"content":{"application/json":{"schema":{"properties":{"name":{"description":"// same name but json, should keep both","type":"string"},"types":{"items":{"enum":["foo,bar","spam|egg"],"type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"required":["name"],"title":"StoryBookFilterWithBody","type":"object"}}},"required":true},"UpdateStoryBooksRequest":{"content":{"application/json":{"schema":{"properties":{"author":{"$ref":"#/components/schemas/Author"},"complicate":{"additionalProperties":{"items":{"additionalProperties":{"items":{"nullable":true,"properties":{"birthday":{"format":"int32","type":"integer"},"books":{"items":{"nullable":true,"properties":{"author":{"$ref":"#/components/schemas/Author"},"created_at":{"format":"int64","type":"integer"},"id":{"format":"int","type":"integer"},"meta":{"additionalProperties":{"items":{"type":"string"},"nullable":true,"type":"array"},"nullable":true,"type":"object"},"name":{"type":"string"},"publish_date":{"format":"int32","type":"integer"},"updated_at":{"format":"int64","type":"integer"}},"required":["publish_date","author","name","meta","id","created_at","updated_at"],"title":"Book","type":"object"},"nullable":true,"type":"array"},"created_at":{"format":"int64","type":"integer"},"id":{"format":"int","type":"integer"},"meta":{"additionalProperties":{"items":{"type":"string"},"nullable":true,"type":"array"},"nullable":true,"type":"object"},"name":{"type":"string"},"updated_at":{"format":"int64","type":"integer"}},"required":["birthday","books","name","meta","id","created_at","updated_at"],"title":"Author","type":"object"},"minItems":2,"nullable":true,"type":"array"},"maxProperties":3,"minProperties":3,"nullable":true,"type":"object"},"maxItems":100,"nullable":true,"type":"array"},"maxProperties":3,"minProperties":3,"nullable":true,"type":"object"},"created_at":{"format":"int64","type":"integer"},"id":{"format":"int","type":"integer"},"meta":{"additionalProperties":{"items":{"type":"string"},"nullable":true,"type":"array"},"nullable":true,"type":"object"},"name":{"type":"string"},"publish_date":{"format":"int32","type":"integer"},"type":{"type":"string"},"updated_at":{"format":"int64","type":"integer"}},"required":["id","created_at","updated_at","name","meta","publish_date","author","type","complicate"],"title":"UpdateStoryBooksRequest","type":"object"}}},"required":true}},"schemas":{"Author":{"nullable":true,"properties":{"birthday":{"format":"int32","type":"integer"},"books":{"items":{"nullable":true,"properties":{"author":{"$ref":"#/components/schemas/Author"},"created_at":{"format":"int64","type":"integer"},"id":{"format":"int","type":"integer"},"meta":{"additionalProperties":{"items":{"type":"string"},"nullable":true,"type":"array"},"nullable":true,"type":"object"},"name":{"type":"string"},"publish_date":{"format":"int32","type":"integer"},"updated_at":{"format":"int64","type":"integer"}},"required":["publish_date","author","name","meta","id","created_at","updated_at"],"title":"Book","type":"object"},"nullable":true,"type":"array"},"created_at":{"format":"int64","type":"integer"},"id":{"format":"int","type":"integer"},"meta":{"additionalProperties":{"items":{"type":"string"},"nullable":true,"type":"array"},"nullable":true,"type":"object"},"name":{"type":"string"},"updated_at":{"format":"int64","type":"integer"}},"required":["birthday","books","name","meta","id","created_at","updated_at"],"title":"Author","type":"object"},"Base":{"properties":{"created_at":{"format":"int64","type":"integer"},"id":{"format":"int","type":"integer"},"meta":{"additionalProperties":{"items":{"type":"string"},"nullable":true,"type":"array"},"nullable":true,"type":"object"},"name":{"type":"string"},"updated_at":{"format":"int64","type":"integer"}},"required":["name","meta","id","created_at","updated_at"],"title":"Base","type":"object"},"BaseModel":{"properties":{"created_at":{"format":"int64","type":"integer"},"id":{"format":"int","type":"integer"},"updated_at":{"format":"int64","type":"integer"}},"required":["id","created_at","updated_at"],"title":"BaseModel","type":"object"},"Book":{"nullable":true,"properties":{"author":{"$ref":"#/components/schemas/Author"},"created_at":{"format":"int64","type":"integer"},"id":{"format":"int","type":"integer"},"meta":{"additionalProperties":{"items":{"type":"string"},"nullable":true,"type":"array"},"nullable":true,"type":"object"},"name":{"type":"string"},"publish_date":{"format":"int32","type":"integer"},"updated_at":{"format":"int64","type":"integer"}},"required":["publish_date","author","name","meta","id","created_at","updated_at"],"title":"Book","type":"object"},"StoryBook":{"properties":{"author":{"$ref":"#/components/schemas/Author"},"created_at":{"format":"int64","type":"integer"},"id":{"format":"int","type":"integer"},"meta":{"additionalProperties":{"items":{"type":"string"},"nullable":true,"type":"array"},"nullable":true,"type":"object"},"name":{"type":"string"},"publish_date":{"format":"int32","type":"integer"},"type":{"type":"string"},"updated_at":{"format":"int64","type":"integer"}},"required":["type","publish_date","author","name","meta","id","created_at","updated_at"],"title":"StoryBook","type":"object"}},"securitySchemes":{"jwt":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"externalDocs":{"url":"https://github.com/jayvynl/goctl-openapi"},"info":{"contact":{"email":"zhiwenlin1116@gmail.com","name":"Lin Zhiwen"},"description":"给出尽可能复杂的场景 测试本项目功能","title":"api 文件示例","version":"v1"},"openapi":"3.0.3","paths":{"/base/health":{"get":{"operationId":"Health","responses":{"200":{"description":"A successful response."}},"tags":["base"]}},"/book/story/{id}":{"post":{"externalDocs":{"url":"https://github.com/jayvynl/goctl-openapi"},"operationId":"UpdateStoryBooks","parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"int","type":"integer"}},{"allowEmptyValue":true,"in":"query","name":"page","schema":{"exclusiveMaximum":true,"format":"uint","maximum":10000,"minimum":1,"type":"integer"}},{"allowEmptyValue":true,"in":"query","name":"page_size","schema":{"default":20,"format":"uint","maximum":100,"minimum":1,"type":"integer"}},{"allowEmptyValue":true,"in":"header","name":"WWW-Authenticate","required":true,"schema":{"type":"string"}},{"allowEmptyValue":true,"in":"query","name":"name","required":true,"schema":{"enum":["fo"],"maxLength":10,"minLength":10,"type":"string"}},{"allowEmptyValue":true,"in":"query","name":"publish_date_gt","schema":{"format":"int32","type":"integer"}},{"allowEmptyValue":true,"in":"query","name":"publish_date_lte","schema":{"format":"int32","type":"integer"}},{"allowEmptyValue":true,"in":"query","name":"author_id","schema":{"exclusiveMinimum":true,"format":"int64","minimum":1,"type":"integer"}},{"allowEmptyValue":true,"in":"query","name":"type","schema":{"enum":["foo,bar","spam|egg"],"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/UpdateStoryBooksRequest"},"responses":{"200":{"description":"A successful response."}},"security":[{"jwt":[]}],"servers":[{"url":"http://another"},{"url":"https://another"}],"summary":"Update story book","tags":["book"]}},"/book/story1/{id}":{"get":{"operationId":"ListStoryBook1","parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"int","type":"integer"}},{"allowEmptyValue":true,"in":"query","name":"page","schema":{"exclusiveMaximum":true,"format":"uint","maximum":10000,"minimum":1,"type":"integer"}},{"allowEmptyValue":true,"in":"query","name":"page_size","schema":{"default":20,"format":"uint","maximum":100,"minimum":1,"type":"integer"}},{"allowEmptyValue":true,"in":"header","name":"WWW-Authenticate","required":true,"schema":{"type":"string"}},{"allowEmptyValue":true,"in":"query","name":"name","schema":{"enum":["fo"],"maxLength":10,"minLength":10,"type":"string"}},{"allowEmptyValue":true,"in":"query","name":"publish_date_gt","schema":{"format":"int32","type":"integer"}},{"allowEmptyValue":true,"in":"query","name":"publish_date_lte","schema":{"format":"int32","type":"integer"}},{"allowEmptyValue":true,"in":"query","name":"author_id","schema":{"exclusiveMinimum":true,"format":"int64","minimum":1,"type":"integer"}},{"allowEmptyValue":true,"in":"query","name":"type","schema":{"enum":["foo,bar","spam|egg"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/StoryBook"},"nullable":true,"type":"array"}}},"description":"A successful response."}},"security":[{"jwt":[]}],"tags":["bar"]}},"/book/story2/{id}":{"post":{"operationId":"ListStoryBook2","parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"int","type":"integer"}},{"allowEmptyValue":true,"in":"query","name":"page","schema":{"exclusiveMaximum":true,"format":"uint","maximum":10000,"minimum":1,"type":"integer"}},{"allowEmptyValue":true,"in":"query","name":"page_size","schema":{"default":20,"format":"uint","maximum":100,"minimum":1,"type":"integer"}},{"allowEmptyValue":true,"in":"header","name":"WWW-Authenticate","required":true,"schema":{"type":"string"}},{"allowEmptyValue":true,"in":"query","name":"name","schema":{"enum":["fo"],"maxLength":10,"minLength":10,"type":"string"}},{"allowEmptyValue":true,"in":"query","name":"publish_date_gt","schema":{"format":"int32","type":"integer"}},{"allowEmptyValue":true,"in":"query","name":"publish_date_lte","schema":{"format":"int32","type":"integer"}},{"allowEmptyValue":true,"in":"query","name":"author_id","schema":{"exclusiveMinimum":true,"format":"int64","minimum":1,"type":"integer"}},{"allowEmptyValue":true,"in":"query","name":"type","schema":{"enum":["foo,bar","spam|egg"],"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/StoryBookFilter"},"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/StoryBook"},"nullable":true,"type":"array"}}},"description":"A successful response."}},"security":[{"jwt":[]}],"tags":["book"]}},"/book/story3/{id}":{"post":{"operationId":"ListStoryBook3","parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"int","type":"integer"}},{"allowEmptyValue":true,"in":"query","name":"page","schema":{"exclusiveMaximum":true,"format":"uint","maximum":10000,"minimum":1,"type":"integer"}},{"allowEmptyValue":true,"in":"query","name":"page_size","schema":{"default":20,"format":"uint","maximum":100,"minimum":1,"type":"integer"}},{"allowEmptyValue":true,"in":"header","name":"WWW-Authenticate","required":true,"schema":{"type":"string"}},{"allowEmptyValue":true,"in":"query","name":"name","required":true,"schema":{"enum":["fo"],"maxLength":10,"minLength":10,"type":"string"}},{"allowEmptyValue":true,"in":"query","name":"publish_date_gt","schema":{"format":"int32","type":"integer"}},{"allowEmptyValue":true,"in":"query","name":"publish_date_lte","schema":{"format":"int32","type":"integer"}},{"allowEmptyValue":true,"in":"query","name":"author_id","schema":{"exclusiveMinimum":true,"format":"int64","minimum":1,"type":"integer"}},{"allowEmptyValue":true,"description":"// same name and same location, should overwrite","in":"query","name":"type","required":true,"schema":{"description":"// same name and same location, should overwrite","enum":["foo","bar","spam","egg"],"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/StoryBookFilterWithBody"},"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/StoryBook"},"nullable":true,"type":"array"}}},"description":"A successful response."}},"security":[{"jwt":[]}],"tags":["foo"]}}},"security":[{"jwt":[]}],"servers":[{"url":"http://localhost/v1"},{"url":"https://localhost/v2"}]}