Init

blueswen · Jun 12, 2022 · e06c4b4 · e06c4b4
commit e06c4b4
Show file tree

Hide file tree

Showing 88 changed files with 9,619 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,163 @@
+.DS_Store
+.vscode/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -0,0 +1 @@
+recursive-include mkdocs_swagger_ui_tag *
diff --git a/README.md b/README.md
@@ -0,0 +1,59 @@
+# MkDocs swagger-ui-tag 
+
+[![PyPI version](https://img.shields.io/pypi/v/mkdocs-swagger-ui-tag.svg)](https://pypi.org/project/mkdocs-swagger-ui-tag)
+[![PyPI downloads](https://img.shields.io/pypi/dm/mkdocs-swagger-ui-tag.svg)](https://pypi.org/project/mkdocs-swagger-ui-tag)
+
+A MkDocs plugin supports for add [Swagger UI](https://github.com/swagger-api/swagger-ui) in page.
+
+[Live demo](https://blueswen.github.io/mkdocs-swagger-ui-tag/) with [mkdocs-material](https://squidfunk.github.io/mkdocs-material/) theme.
+
+## Features
+
+1. Multiple OpenAPI Specification file source: url, static file in docs
+2. Multiple Swagger UI in same page
+
+## Dependency
+
+1. Python Package
+    1. beautifulsoup4==4.11.1
+2. [Swagger UI dist](https://www.npmjs.com/package/swagger-ui-dist) javascript file and css file
+    1. swagger-ui-dist==4.12.0
+
+## Usage
+
+1. Install plugin from pypi
+
+    ```bash
+    pip install mkdocs-swagger-ui-tag
+    ```
+
+2. Add ```swagger-ui-tag``` plugin in to your mkdocs.yml plugins sections:
+
+    ```yaml
+    plugins:
+       - swagger-ui-tag
+    ```
+
+3. You may customize the plugin by passing options in mkdocs.yml:
+
+    ```yaml
+    plugins:
+       - swagger-ui-tag:
+            background: White
+    ```
+
+    | Option     | Default | Description                                                                                                                                       |
+    |------------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------|
+    | background | White   | Swagger UI iframe body background attribute value. You can use any css value for background for example "#74b9ff" or Gainsboro or "" for nothing. |
+
+4. Add ```swagger-ui``` tag in markdown to include Swagger UI
+
+    ```markdown
+    <swagger-ui src="https://petstore.swagger.io/v2/swagger.json"/>
+    ```
+
+    ![Swagger UI Sample Image](demo-mkdocs/docs/sample.png)
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/Blueswen/mkdocs-swagger-ui-tag/blob/main/LICENSE) file for details.
diff --git a/demo-mkdocs/docs/demo/multiple.md b/demo-mkdocs/docs/demo/multiple.md
@@ -0,0 +1,13 @@
+Support render multiple Swagger UI.
+
+## Markdown
+
+```markdown
+<swagger-ui src="./openapi-spec/sample.yaml"/>
+<swagger-ui src="https://petstore.swagger.io/v2/swagger.json"/>
+```
+
+## Swagger UI
+
+<swagger-ui src="./openapi-spec/sample.yaml"/>
+<swagger-ui src="https://petstore.swagger.io/v2/swagger.json"/>
diff --git a/demo-mkdocs/docs/demo/openapi-spec/sample.yaml b/demo-mkdocs/docs/demo/openapi-spec/sample.yaml
@@ -0,0 +1,107 @@
+openapi: "3.0.0"
+info:
+  version: 1.0.0
+  title: Sample OpenAPI Spec
+servers:
+  - url: http://petstore.swagger.io/v1
+paths:
+  /pets:
+    get:
+      summary: List all pets
+      operationId: listPets
+      tags:
+        - pets
+      parameters:
+        - name: limit
+          in: query
+          description: How many items to return at one time (max 100)
+          required: false
+          schema:
+            type: integer
+            format: int32
+      responses:
+        200:
+          description: An paged array of pets
+          headers:
+            x-next:
+              description: A link to the next page of responses
+              schema:
+                type: string
+          content:
+            application/json:    
+              schema:
+                $ref: "#/components/schemas/Pets"
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+    post:
+      summary: Create a pet
+      operationId: createPets
+      tags:
+        - pets
+      responses:
+        201:
+          description: Null response
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+  /pets/{petId}:
+    get:
+      summary: Info for a specific pet
+      operationId: showPetById
+      tags:
+        - pets
+      parameters:
+        - name: petId
+          in: path
+          required: true
+          description: The id of the pet to retrieve
+          schema:
+            type: string
+      responses:
+        200:
+          description: Expected response to a valid request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Pets"
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+components:
+  schemas:
+    Pet:
+      required:
+        - id
+        - name
+      properties:
+        id:
+          type: integer
+          format: int64
+        name:
+          type: string
+        tag:
+          type: string
+    Pets:
+      type: array
+      items:
+        $ref: "#/components/schemas/Pet"
+    Error:
+      required:
+        - code
+        - message
+      properties:
+        code:
+          type: integer
+          format: int32
+        message:
+          type: string
diff --git a/demo-mkdocs/docs/demo/static-file.md b/demo-mkdocs/docs/demo/static-file.md
@@ -0,0 +1,11 @@
+Support using local OpenAPI Specification file on website.
+
+## Markdown
+
+```markdown
+<swagger-ui src="./openapi-spec/sample.yaml"/>
+```
+
+## Swagger UI
+
+<swagger-ui src="./openapi-spec/sample.yaml"/>