{"id":15772793,"url":"https://github.com/mjanez/ckan-openapi","last_synced_at":"2026-01-08T12:50:37.006Z","repository":{"id":225800430,"uuid":"761838718","full_name":"mjanez/ckan-openapi","owner":"mjanez","description":"Documents the CKAN API using Swagger.","archived":false,"fork":false,"pushed_at":"2024-04-11T10:02:39.000Z","size":1326,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-04-11T11:25:09.598Z","etag":null,"topics":["api","ckan","documentation","swagger"],"latest_commit_sha":null,"homepage":"https://mjanez.github.io/ckan-openapi/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mjanez.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2024-02-22T15:30:06.000Z","updated_at":"2024-04-15T11:26:32.768Z","dependencies_parsed_at":"2024-03-04T11:55:57.085Z","dependency_job_id":"992eff2a-20e7-402e-89cd-a00fc6b1d796","html_url":"https://github.com/mjanez/ckan-openapi","commit_stats":null,"previous_names":["mjanez/ckan-openapi"],"tags_count":0,"template":false,"template_full_name":"peter-evans/swagger-github-pages","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mjanez%2Fckan-openapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mjanez%2Fckan-openapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mjanez%2Fckan-openapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mjanez%2Fckan-openapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mjanez","download_url":"https://codeload.github.com/mjanez/ckan-openapi/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246465251,"owners_count":20781919,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","ckan","documentation","swagger"],"created_at":"2024-10-04T15:42:12.548Z","updated_at":"2026-01-08T12:50:36.978Z","avatar_url":"https://github.com/mjanez.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# How to host Swagger API documentation with GitHub Pages\n[\u003cimg alt=\"The blog of Peter Evans: How to Host Swagger Documentation With Github Pages\" title=\"View blog post\" src=\"https://peterevans.dev/img/blog-published-badge.svg\"\u003e](https://peterevans.dev/posts/how-to-host-swagger-docs-with-github-pages/)\n\nThis repository is a template for using the [Swagger UI](https://github.com/swagger-api/swagger-ui) to dynamically generate beautiful documentation for your API and host it for free with GitHub Pages.\n\nThe template will periodically auto-update the Swagger UI dependency and create a pull request. See the [GitHub Actions workflow here](.github/workflows/update-swagger.yml).\n\nThe example API specification used by this repository can be seen hosted at [https://peter-evans.github.io/swagger-github-pages](https://peter-evans.github.io/swagger-github-pages/).\n\n## Steps to use this template\n\n1. Click the `Use this template` button above to create a new repository from this template.\n\n2. Go to the settings for your repository at `https://github.com/{github-username}/{repository-name}/settings` and enable GitHub Pages.\n\n    ![Headers](/screenshots/swagger-github-pages.png?raw=true)\n    \n3. Browse to the Swagger documentation at `https://{github-username}.github.io/{repository-name}/`.\n\n\n## Steps to manually configure in your own repository\n\n1. Download the latest stable release of the Swagger UI [here](https://github.com/swagger-api/swagger-ui/releases).\n\n2. Extract the contents and copy the \"dist\" directory to the root of your repository.\n\n3. Move the file \"index.html\" from the directory \"dist\" to the root of your repository.\n    ```\n    mv dist/index.html .\n    ```\n    \n4. Copy the YAML specification file for your API to the root of your repository.\n\n5. Edit [dist/swagger-initializer.js](dist/swagger-initializer.js) and change the `url` property to reference your local YAML file. \n    ```javascript\n        window.ui = SwaggerUIBundle({\n            url: \"swagger.yaml\",\n        ...\n    ```\n    Then fix any references to files in the \"dist\" directory.\n    ```html\n    ...\n    \u003clink rel=\"stylesheet\" type=\"text/css\" href=\"dist/swagger-ui.css\" \u003e\n    \u003clink rel=\"icon\" type=\"image/png\" href=\"dist/favicon-32x32.png\" sizes=\"32x32\" /\u003e\n    \u003clink rel=\"icon\" type=\"image/png\" href=\"dist/favicon-16x16.png\" sizes=\"16x16\" /\u003e    \n    ...\n    \u003cscript src=\"dist/swagger-ui-bundle.js\"\u003e \u003c/script\u003e\n    \u003cscript src=\"dist/swagger-ui-standalone-preset.js\"\u003e \u003c/script\u003e    \n    ...\n    ```\n    \n6. Go to the settings for your repository at `https://github.com/{github-username}/{repository-name}/settings` and enable GitHub Pages.\n\n    ![Headers](/screenshots/swagger-github-pages.png?raw=true)\n    \n7. Browse to the Swagger documentation at `https://{github-username}.github.io/{repository-name}/`.\n\n   The example API specification used by this repository can be seen hosted at [https://peter-evans.github.io/swagger-github-pages](https://peter-evans.github.io/swagger-github-pages/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmjanez%2Fckan-openapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmjanez%2Fckan-openapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmjanez%2Fckan-openapi/lists"}