yujunjun/strapi
1
0
Fork 0
mirror of https://github.com/strapi/strapi.git synced 2025-07-20 15:36:59 +00:00
Code Issues Packages Projects Releases Wiki Activity
strapi/packages/strapi-plugin-documentation/public/index.html

471 lines
30 KiB
HTML
Raw Normal View History

Add token in swagger and fix private fields
2018-12-06 18:03:56 +01:00
<!-- HTML for static distribution bundle build --><!DOCTYPE html><html lang="en"><head>
<meta charset="UTF-8">
<title>Swagger UI</title>
<link rel="stylesheet" type="text/css" href="/plugins/documentation/swagger-ui.css">
<link rel="icon" type="image/png" href="/plugins/documentation/favicon-32x32.png" sizes="32x32">
<link rel="icon" type="image/png" href="/plugins/documentation/favicon-16x16.png" sizes="16x16">
<style>
html
{
box-sizing: border-box;
overflow: -moz-scrollbars-vertical;
overflow-y: scroll;
}
*,
*:before,
*:after
{
box-sizing: inherit;
}
body
{
margin:0;
background: #fafafa;
}
</style>
</head>
<body>
<div id="swagger-ui"></div>
<script src="/plugins/documentation/swagger-ui-bundle.js"> </script>
<script src="/plugins/documentation/swagger-ui-standalone-preset.js"> </script>
Rename docs version name
2019-06-01 08:51:42 -07:00
Add token in swagger and fix private fields
2018-12-06 18:03:56 +01:00
<script class="custom-swagger-ui">
window.onload = function() {
// Build a system
const ui = SwaggerUIBundle({
url: "https://petstore.swagger.io/v2/swagger.json",
Fix documention typo
2019-07-05 03:05:36 +02:00
spec: {"openapi":"3.0.0","info":{"version":"1.0.0","title":"DOCUMENTATION","description":"","termsOfService":"YOUR_TERMS_OF_SERVICE_URL","contact":{"name":"TEAM","email":"contact-email@something.io","url":"mywebsite.io"},"license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0.html"},"x-generation-date":"12/07/2018 12:13:25 AM"},"x-strapi-config":{"path":"/documentation","showGeneratedFiles":true},"servers":[{"url":"http://localhost:1337","description":"Development server"},{"url":"YOUR_STAGING_SERVER","description":"Staging server server"},{"url":"YOUR_PRODUCTION_SERVER","description":"Production server"}],"externalDocs":{"description":"Find out more","url":"https://strapi.io/documentation/3.0.0-beta.x/"},"security":[{"bearerAuth":[]}],"paths":{"/email/":{"post":{"deprecated":false,"description":"Send an email using the provider defined through the dashboard","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"properties":{"foo":{"type":"string"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Email"],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"from":{"type":"string","format":"email"},"to":{"type":"string","format":"email","example":"user@example.com"},"reply_to":{"type":"string","format":"email"},"subject":{"type":"string","example":"Lorem ipsum title"},"text":{"type":"string","example":"Lorem ipsum"},"html":{"type":"string","format":"html","example":"<h1>Lorem ipsum</h1>"}}}}}}}},"/upload/":{"post":{"deprecated":false,"description":"Upload one or multiple files","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"hash":{"type":"string","format":"uuid"},"sha256":{"type":"string"},"ext":{"type":"string"},"mime":{"type":"string"},"size":{"type":"integer"},"url":{"type":"string","format":"uri"},"provider":{"type":"string"},"related":{"type":"array","items":{"type":"object"}}}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Upload - File"],"requestBody":{"description":"","required":true,"content":{"multipart/form-data":{"schema":{"required":["files"],"properties":{"files":{"type":"array","items":{"type":"string","format":"binary"}},"path":{"type":"string","example":"/public/upload"},"refId":{"type":"string","example":"5a993616b8e66660e8baf45c"},"ref":{"type":"string","example":"user"},"source":{"type":"string","example":"users-permissions"},"field":{"type":"string","example":"avatar"}}}}}}}},"/upload/files/count":{"get":{"deprecated":false,"description":"Retrieve the total number of uploaded files","responses":{"200":{"description":"","content":{"application/json":{"schema":{"properties":{"count":{"type":"integer"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Upload - File"],"parameters":[]}},"/upload/files":{"get":{"deprecated":false,"description":"Retrieve all file documents","responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{
Add token in swagger and fix private fields
2018-12-06 18:03:56 +01:00
dom_id: '#swagger-ui',
docExpansion: "none",
deepLinking: true,
presets: [
SwaggerUIBundle.presets.apis,
SwaggerUIStandalonePreset
],
plugins: [
SwaggerUIBundle.plugins.DownloadUrl
],
layout: "StandaloneLayout"
})
window.ui = ui
}
</script>
</body></html>
Reference in New Issue Copy Permalink