llvy.ltd/casdoor
1
0
Fork 0
mirror of https://github.com/casdoor/casdoor.git synced 2025-07-03 04:10:20 +08:00
Code Issues Packages Projects Releases Wiki Activity

Improve swagger docs

Browse Source
This commit is contained in:
Yang Luo
2023-07-29 11:35:03 +08:00
parent 5f054c4989
commit a38896e4d8
3 changed files with 36 additions and 76 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
routers/router.go
View File

@ -13,13 +13,13 @@
// limitations under the License. // limitations under the License.
// Package routers // Package routers
// @APIVersion 1.0.0 // @APIVersion 1.376.1
// @Title Casdoor API // @Title Casdoor RESTful API
// @Description Documentation of Casdoor API // @Description Swagger Docs of Casdoor Backend API
// @Contact admin@casbin.org // @Contact casbin@googlegroups.com
// @SecurityDefinition test_apiKey apiKey Authorization header // @SecurityDefinition AccessToken apiKey Authorization header
// @Schemes http,https // @Schemes https,http
// @ExternalDocs Find out more about casdoor // @ExternalDocs Find out more about Casdoor
// @ExternalDocsUrl https://casdoor.org/ // @ExternalDocsUrl https://casdoor.org/
package routers package routers

60
swagger/swagger.json
View File

@ -1,17 +1,17 @@
{ {
"swagger": "2.0", "swagger": "2.0",
"info": { "info": {
"title": "Casdoor API", "title": "Casdoor RESTful API",
"description": "Documentation of Casdoor API", "description": "Swagger Docs of Casdoor Backend API",
"version": "1.0.0", "version": "1.376.1",
"contact": { "contact": {
"email": "admin@casbin.org" "email": "casbin@googlegroups.com"
} }
}, },
"basePath": "/", "basePath": "/",
"schemes": [ "schemes": [
"http", "https",
"https" "http"
], ],
"paths": { "paths": {
"/.well-known/jwks": { "/.well-known/jwks": {
@ -5485,13 +5485,13 @@
"properties": { "properties": {
"data": { "data": {
"additionalProperties": { "additionalProperties": {
"description": "support string | class | List\u003cclass\u003e and os on", "description": "support string, struct or []struct",
"type": "string" "type": "string"
} }
}, },
"data2": { "data2": {
"additionalProperties": { "additionalProperties": {
"description": "support string | class | List\u003cclass\u003e and os on", "description": "support string, struct or []struct",
"type": "string" "type": "string"
} }
}, },
@ -7771,21 +7771,15 @@
"type": "object", "type": "object",
"properties": { "properties": {
"contentType": { "contentType": {
"default": "application/json", "type": "string"
"type": "string",
"example": "application/json"
}, },
"createdTime": { "createdTime": {
"default": "2023-07-27T17:09:12+08:00", "type": "string"
"type": "string",
"example": "2023-07-27T17:09:12+08:00"
}, },
"events": { "events": {
"type": "array", "type": "array",
"items": { "items": {
"type": "string", "type": "string"
"default": "test",
"example": "test"
} }
}, },
"headers": { "headers": {
@ -7795,39 +7789,25 @@
} }
}, },
"isEnabled": { "isEnabled": {
"default": true, "type": "boolean"
"type": "boolean",
"example": true
}, },
"isUserExtended": { "isUserExtended": {
"default": true, "type": "boolean"
"type": "boolean",
"example": true
}, },
"method": { "method": {
"default": "POST", "type": "string"
"type": "string",
"example": "POST"
}, },
"name": { "name": {
"default": "test", "type": "string"
"type": "string",
"example": "test"
}, },
"organization": { "organization": {
"default": "built-in", "type": "string"
"type": "string",
"example": "built-in"
}, },
"owner": { "owner": {
"default": "built-in", "type": "string"
"type": "string",
"example": "built-in"
}, },
"url": { "url": {
"default": "https://example.com/callback", "type": "string"
"type": "string",
"example": "https://example.com/callback"
} }
} }
}, },
@ -7894,14 +7874,14 @@
} }
}, },
"securityDefinitions": { "securityDefinitions": {
"test_apiKey": { "AccessToken": {
"type": "apiKey", "type": "apiKey",
"name": "Authorization", "name": "Authorization",
"in": "header" "in": "header"
} }
}, },
"externalDocs": { "externalDocs": {
"description": "Find out more about casdoor", "description": "Find out more about Casdoor",
"url": "https://casdoor.org/" "url": "https://casdoor.org/"
} }
} }

38
swagger/swagger.yml
View File

@ -1,14 +1,14 @@
swagger: "2.0" swagger: "2.0"
info: info:
title: Casdoor API title: Casdoor RESTful API
description: Documentation of Casdoor API description: Swagger Docs of Casdoor Backend API
version: 1.0.0 version: 1.376.1
contact: contact:
email: admin@casbin.org email: casbin@googlegroups.com
basePath: / basePath: /
schemes: schemes:
- http
- https - https
- http
paths: paths:
/.well-known/jwks: /.well-known/jwks:
get: get:
@ -3589,11 +3589,11 @@ definitions:
properties: properties:
data: data:
additionalProperties: additionalProperties:
description: support string | class | List<class> and os on description: support string, struct or []struct
type: string type: string
data2: data2:
additionalProperties: additionalProperties:
description: support string | class | List<class> and os on description: support string, struct or []struct
type: string type: string
msg: msg:
type: string type: string
@ -5126,51 +5126,31 @@ definitions:
type: object type: object
properties: properties:
contentType: contentType:
default: application/json
type: string type: string
example: application/json
createdTime: createdTime:
default: "2023-07-27T17:09:12+08:00"
type: string type: string
example: "2023-07-27T17:09:12+08:00"
events: events:
default: '[ddd]'
type: array type: array
items: items:
type: string type: string
headers: headers:
default: '[]'
type: array type: array
items: items:
$ref: '#/definitions/object.Header' $ref: '#/definitions/object.Header'
isEnabled: isEnabled:
default: true
type: boolean type: boolean
example: true
isUserExtended: isUserExtended:
default: true
type: boolean type: boolean
example: true
method: method:
default: POST
type: string type: string
example: POST
name: name:
default: test
type: string type: string
example: test
organization: organization:
default: built-in
type: string type: string
example: built-in
owner: owner:
default: built-in
type: string type: string
example: built-in
url: url:
default: https://example.com/callback
type: string type: string
example: https://example.com/callback
protocol.CredentialAssertion: protocol.CredentialAssertion:
title: CredentialAssertion title: CredentialAssertion
type: object type: object
@ -5216,10 +5196,10 @@ definitions:
title: Engine title: Engine
type: object type: object
securityDefinitions: securityDefinitions:
test_apiKey: AccessToken:
type: apiKey type: apiKey
name: Authorization name: Authorization
in: header in: header
externalDocs: externalDocs:
description: Find out more about casdoor description: Find out more about Casdoor
url: https://casdoor.org/ url: https://casdoor.org/