diff --git a/README.md b/README.md index 490ae74..c0260f2 100644 --- a/README.md +++ b/README.md @@ -54,8 +54,8 @@ - [Dockerized](https://arifszn.github.io/pandora/docs/installation#with-docker-sail) - [OpenAPI Specification](https://arifszn.github.io/pandora/docs/features/openapi-specification) -- [Swagger UI](https://arifszn.github.io/pandora/docs/api-documentation/swagger-ui) - [Redoc](https://arifszn.github.io/pandora/docs/api-documentation/redoc) +- [Swagger UI](https://arifszn.github.io/pandora/docs/api-documentation/swagger-ui) - [Service Repository Pattern](https://arifszn.github.io/pandora/docs/features/service-repository-pattern) - [API Resource](https://arifszn.github.io/pandora/docs/features/api-resource) - [Code Style & Lint](https://arifszn.github.io/pandora/docs/features/code-style-and-lint) diff --git a/resources/views/openapi-spec/redoc.blade.php b/resources/views/openapi-spec/redoc.blade.php index c2fd184..c7c408d 100644 --- a/resources/views/openapi-spec/redoc.blade.php +++ b/resources/views/openapi-spec/redoc.blade.php @@ -4,9 +4,8 @@ - + {{Config::get('app.name')}} - Documentation - diff --git a/resources/views/openapi-spec/swagger.blade.php b/resources/views/openapi-spec/swagger.blade.php index 913bae1..87bbbb5 100644 --- a/resources/views/openapi-spec/swagger.blade.php +++ b/resources/views/openapi-spec/swagger.blade.php @@ -4,7 +4,7 @@ - + {{Config::get('app.name')}} - Documentation diff --git a/routes/web.php b/routes/web.php index 891b7cb..1c4983f 100644 --- a/routes/web.php +++ b/routes/web.php @@ -16,14 +16,14 @@ }); } -if (Config::get('pandora.api_doc.display_swagger_ui')) { - Route::get('/swagger-ui', function () { - return view('openapi-spec.swagger'); - }); -} - if (Config::get('pandora.api_doc.display_redoc')) { Route::get('/redoc', function () { return view('openapi-spec.redoc'); }); } + +if (Config::get('pandora.api_doc.display_swagger_ui')) { + Route::get('/swagger-ui', function () { + return view('openapi-spec.swagger'); + }); +} diff --git a/website/docs/1-introduction.md b/website/docs/1-introduction.md index 575a5d1..ab24106 100644 --- a/website/docs/1-introduction.md +++ b/website/docs/1-introduction.md @@ -55,8 +55,8 @@ hide_title: true - [Dockerized](/docs/installation#with-docker-sail) - [OpenAPI Specification](/docs/features/openapi-specification) -- [Swagger UI](/docs/api-documentation/swagger-ui) - [Redoc](/docs/api-documentation/redoc) +- [Swagger UI](/docs/api-documentation/swagger-ui) - [Service Repository Pattern](/docs/features/service-repository-pattern) - [API Resource](/docs/features/api-resource) - [Code Style & Lint](/docs/features/code-style-and-lint) diff --git a/website/docs/3-api-documentation/2-redoc.md b/website/docs/3-api-documentation/1-redoc.md similarity index 53% rename from website/docs/3-api-documentation/2-redoc.md rename to website/docs/3-api-documentation/1-redoc.md index 3dd900f..cc85914 100644 --- a/website/docs/3-api-documentation/2-redoc.md +++ b/website/docs/3-api-documentation/1-redoc.md @@ -6,4 +6,8 @@ hide_table_of_contents: true import ApiDocMdx from '@theme/ApiDocMdx'; - +
+
+ +
+
diff --git a/website/docs/3-api-documentation/1-swagger-ui.md b/website/docs/3-api-documentation/1-swagger-ui.md deleted file mode 100644 index 48df055..0000000 --- a/website/docs/3-api-documentation/1-swagger-ui.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Swagger UI -hide_title: true -hide_table_of_contents: true ---- - -import SwaggerUI from "swagger-ui-react"; -import "swagger-ui-react/swagger-ui.css"; - - diff --git a/website/docs/3-api-documentation/2-swagger-ui.md b/website/docs/3-api-documentation/2-swagger-ui.md new file mode 100644 index 0000000..58eb84b --- /dev/null +++ b/website/docs/3-api-documentation/2-swagger-ui.md @@ -0,0 +1,14 @@ +--- +title: Swagger UI +hide_title: true +hide_table_of_contents: true +--- + +import SwaggerUI from "swagger-ui-react"; +import "../../src/css/swagger-ui.css"; + +
+
+ +
+
diff --git a/website/docs/4-features/1-openapi-specification.md b/website/docs/4-features/1-openapi-specification.md index 8472290..1344c4a 100644 --- a/website/docs/4-features/1-openapi-specification.md +++ b/website/docs/4-features/1-openapi-specification.md @@ -48,4 +48,4 @@ To generate the OpenAPI Specification file, run command: composer openapi ``` -It will generate the `openapi.yaml` file in the public folder which can be viewed in the Swagger UI. +It will generate the `openapi.yaml` file in the public folder which can be viewed in the Redoc or Swagger UI. diff --git a/website/src/css/custom.css b/website/src/css/custom.css index f75a28c..cc35e66 100644 --- a/website/src/css/custom.css +++ b/website/src/css/custom.css @@ -80,10 +80,6 @@ div[class^='announcementBar_'] { width: 24px; } -.swagger-ui .info .title small pre { - background-color: unset; -} - html[data-theme='dark'] .header-github-link:before { background: url("data:image/svg+xml;charset=utf-8,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath fill='%23fff' d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12'/%3E%3C/svg%3E") no-repeat; diff --git a/website/src/css/swagger-ui.css b/website/src/css/swagger-ui.css index 6311310..72a4a8e 100644 --- a/website/src/css/swagger-ui.css +++ b/website/src/css/swagger-ui.css @@ -7961,6 +7961,7 @@ .swagger-ui .expand-operation svg { height: 20px; width: 20px; + fill: var(--ifm-color-content); } .swagger-ui .expand-methods { padding: 0 10px; @@ -8476,7 +8477,7 @@ opacity: 0.5; } .swagger-ui .model-title { - color: #505050; + color: var(--ifm-color-content-secondary); font-family: sans-serif; font-size: 16px; }