llvy.ltd/casdoor
1
0
Fork 0
mirror of https://github.com/casdoor/casdoor.git synced 2025-07-02 19:40:19 +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.
// Package routers
// @APIVersion 1.0.0
// @Title Casdoor API
// @Description Documentation of Casdoor API
// @Contact admin@casbin.org
// @SecurityDefinition test_apiKey apiKey Authorization header
// @Schemes http,https
// @ExternalDocs Find out more about casdoor
// @APIVersion 1.376.1
// @Title Casdoor RESTful API
// @Description Swagger Docs of Casdoor Backend API
// @Contact casbin@googlegroups.com
// @SecurityDefinition AccessToken apiKey Authorization header
// @Schemes https,http
// @ExternalDocs Find out more about Casdoor
// @ExternalDocsUrl https://casdoor.org/
package routers

60
swagger/swagger.json
View File

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

38
swagger/swagger.yml
View File

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