{"id":14525270,"url":"https://github.com/swagger-api/swagger.io-docs","last_synced_at":"2025-05-14T05:10:29.573Z","repository":{"id":20320516,"uuid":"23594674","full_name":"swagger-api/swagger.io-docs","owner":"swagger-api","description":"The content of swagger.io","archived":false,"fork":false,"pushed_at":"2025-03-06T12:35:42.000Z","size":4051,"stargazers_count":1558,"open_issues_count":54,"forks_count":408,"subscribers_count":115,"default_branch":"main","last_synced_at":"2025-04-13T12:48:43.542Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://swagger.io/docs/","language":"Astro","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/swagger-api.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,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2014-09-02T20:37:12.000Z","updated_at":"2025-03-06T12:35:46.000Z","dependencies_parsed_at":"2024-09-04T14:01:43.936Z","dependency_job_id":"fc274805-38a7-4daa-8293-902d7c364e6a","html_url":"https://github.com/swagger-api/swagger.io-docs","commit_stats":null,"previous_names":["swagger-api/swagger.io-docs","swagger-api/swagger.io"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swagger-api%2Fswagger.io-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swagger-api%2Fswagger.io-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swagger-api%2Fswagger.io-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swagger-api%2Fswagger.io-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/swagger-api","download_url":"https://codeload.github.com/swagger-api/swagger.io-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254076848,"owners_count":22010611,"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":[],"created_at":"2024-09-04T14:01:20.338Z","updated_at":"2025-05-14T05:10:29.561Z","avatar_url":"https://github.com/swagger-api.png","language":"Astro","readme":"\n# \u003cimg src=\"https://raw.githubusercontent.com/swagger-api/swagger.io/wordpress/images/assets/SW-logo-clr.png\" height=\"60\"\u003e  \n\nFor general support questions, please refer to the [Community Forums](https://community.smartbear.com/t5/Swagger-Open-Source-Tools/bd-p/SwaggerOSTools).\n\n# Swagger Open Source Documentation\n\nWelcome to the Swagger Open Source Documentation repository. This repository contains all the documentation for Swagger, an open-source suite of tools for API development, and OpenAPI Specification (FKA Swagger). The content of this repository is published at https://swagger.io/docs/.\n\n\n## Tech Stack\n\nWe use [Astro](https://astro.build) to build and maintain our documentation. Astro is a powerful static site generator that allows us to create performant, content-rich documentation sites with ease.\n\n## Contributing\n\nWe welcome contributions from the community! To contribute:\n\n1. Fork the repository by clicking the \"Fork\" button on the top right of the repo page (this creates a copy under your GitHub account).\n2. Clone your fork (`git clone https://github.com/your-username/swagger.io-docs.git`).\n3. Create a new branch for your feature (`git checkout -b feature-branch-name`).\n4. Make your changes locally.\n5. Commit your changes (`git commit -m 'Add some feature'`).\n6. Push to your fork (`git push origin feature-branch-name`).\n7. Open a pull request from your fork on GitHub.\n8. A maintainer will review your changes and merge them if approved.\n\nPlease ensure your change adheres to best practices and is well-documented.\n\n## Running the Documentation Locally\n\n### Getting Started\n\nTo get started with contributing to the Swagger Open Source Docs, follow these steps:\n\n#### Prerequisites\n\nEnsure you have the following installed on your machine:\n- [Node.js](https://nodejs.org/) (version 14 or later)\n- [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/)\n\n#### Installation\n\n1. Clone the repository:\n\n    ```bash\n    git clone https://github.com/swagger-api/swagger.io-docs.git\n    cd swagger.io\n    ```\n\n2. Install dependencies:\n\n    ```bash\n    npm install\n    # or\n    yarn install\n    ```\n\n#### Running the Development Server\n\nTo start the development server and view the documentation locally:\n\n```bash\nnpm run dev\n# or\nyarn dev\n```\n\nThis will start the development server at `http://localhost:4321`, where you can view and edit the documentation.\n\n#### Building the Documentation\n\nTo build the documentation for production:\n\n```bash\nnpm run build\n# or\nyarn build\n```\n\nThe built files will be output to the `dist` directory.","funding_links":[],"categories":["Astro"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswagger-api%2Fswagger.io-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fswagger-api%2Fswagger.io-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswagger-api%2Fswagger.io-docs/lists"}