{"id":22085593,"url":"https://github.com/nexmo/nexmo-oas-renderer","last_synced_at":"2025-04-04T21:07:30.864Z","repository":{"id":34934750,"uuid":"186776115","full_name":"Nexmo/nexmo-oas-renderer","owner":"Nexmo","description":"Render your API references, Nexmo-style!","archived":false,"fork":false,"pushed_at":"2024-10-14T03:28:28.000Z","size":3663,"stargazers_count":46,"open_issues_count":15,"forks_count":4,"subscribers_count":13,"default_branch":"main","last_synced_at":"2025-03-28T20:06:58.040Z","etag":null,"topics":["developer-destination","documentation","nexmo","oas3","openapi","openapi3","ruby-on-rails","tools"],"latest_commit_sha":null,"homepage":"https://developer.nexmo.com/api","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Nexmo.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","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}},"created_at":"2019-05-15T07:47:32.000Z","updated_at":"2024-09-11T10:12:22.000Z","dependencies_parsed_at":"2024-02-22T05:23:01.672Z","dependency_job_id":"152c3612-9d39-474c-a6c8-928e9de56c61","html_url":"https://github.com/Nexmo/nexmo-oas-renderer","commit_stats":{"total_commits":245,"total_committers":12,"mean_commits":"20.416666666666668","dds":0.4448979591836735,"last_synced_commit":"d655f943ea0ff0dcae56a3b34228a971798aa877"},"previous_names":[],"tags_count":37,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nexmo%2Fnexmo-oas-renderer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nexmo%2Fnexmo-oas-renderer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nexmo%2Fnexmo-oas-renderer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nexmo%2Fnexmo-oas-renderer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Nexmo","download_url":"https://codeload.github.com/Nexmo/nexmo-oas-renderer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247249524,"owners_count":20908212,"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":["developer-destination","documentation","nexmo","oas3","openapi","openapi3","ruby-on-rails","tools"],"created_at":"2024-12-01T01:15:12.100Z","updated_at":"2025-04-04T21:07:30.845Z","avatar_url":"https://github.com/Nexmo.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Nexmo OAS Renderer\n\n![Build Status](https://github.com/Nexmo/nexmo-oas-renderer/workflows/CI/badge.svg)\n[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE.txt)\n\nSinatra application that provides a preview of how the OAS documents will be rendered within [Nexmo Developer](https://developer.nexmo.com/).\n\n* [Dependencies](#requirements)\n* [Installation and Usage](#installation-and-usage)\n    * [Using Docker](#using-docker)\n    * [As a standalone application](#as-a-standalone-application)\n    * [Mounted into a Rails application](#mounted-into-a-rails-application)\n    * [Specifying the path to the documents](#specifying-the-path-to-the-documents)\n* [Contributing](#contributing)\n* [License](#license)\n\n## Dependencies\n\n\n## Installation and Usage\n\n### Using Docker\n\nYou can run using Docker and it will serve the current directory (this will usually be the api-specification repo):\n\n#### Mac/Linux\n\n```bash\ndocker run --rm -p 4567:4567 -v `pwd`:/definitions -e 'OAS_PATH=/definitions' nexmodev/nexmo-oas-renderer:latest\n```\n\nAlternatively, add the following to your `~/.bashrc` file and you'll be able to run `nexmo-oas-renderer`\n\n```\nfunction nexmo-oas-renderer() {\n  docker run --rm -p 4567:4567 -v `pwd`:/definitions -e 'OAS_PATH=/definitions' nexmodev/nexmo-oas-renderer:latest\n}\n```\n\n#### Windows\n\n```ps\ndocker run --rm -p 4567:4567 -v %CD%:/definitions -e 'OAS_PATH=/definitions' nexmodev/nexmo-oas-renderer:latest\n```\n\n### As a standalone application\n\nInstall the gem:\n\n``` shell\n$ gem install nexmo-oas-renderer\n```\n\nAnd simply run the executable with the corresponding env variables set (see [Note](#note)):\n``` shell\n$ nexmo-oas-renderer\n```\n\nOr, if you want to make code changes, just run the following command which will start the web server on http://localhost:9393:\n``` shell\nOAS_PATH=... bundle exec shotgun lib/nexmo/oas/renderer/config.ru\n```\n\n### Mounted into a Rails Application\n\nAdd this to your application's `Gemfile`:\n\n```\ngem 'nexmo-oas-renderer', require: false\n```\n\nAnd then run `bundle install`.\n\nRequire the gem in `config/environment.rb` as follows:\n\n``` ruby\n# Load the Rails application.\nrequire_relative 'application'\n\nrequire 'nexmo/oas/renderer'\n\n# Initialize the Rails application.\nRails.application.initialize!\n```\n\nAnd finally mount the Sinatra app into your Rails application by adding the following line to `config/routes.rb`:\n\n``` ruby\nmount Nexmo::OAS::Renderer::API, at: '/api'\n```\n\n### Specifying the path to the documents\n\nThis gem uses [dotenv](https://github.com/bkeepers/dotenv) to handle environment variables, so you should copy the `.env.example` provided by running:\n``` shell\n$ cp .env.example .env\n```\nand assign values to the corresponding variables.\n\n#### Note\nThe env variable `OAS_PATH` indicates the path to the documents that will be rendered.\n\n## Contributing\nWe ❤️ contributions from everyone! [Bug reports](https://github.com/Nexmo/nexmo-oas-renderer/issues), [bug fixes](https://github.com/Nexmo/nexmo-oas-renderer/pulls) and feedback on the library is always appreciated. Look at the [Contributor Guidelines](https://github.com/Nexmo/nexmo-oas-renderer/blob/master/CONTRIBUTING.md) for more information and please follow the [GitHub Flow](https://guides.github.com/introduction/flow/index.html).\n\n## License\nThis project is under the [MIT LICENSE](https://github.com/Nexmo/nexmo-oas-renderer/blob/master/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnexmo%2Fnexmo-oas-renderer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnexmo%2Fnexmo-oas-renderer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnexmo%2Fnexmo-oas-renderer/lists"}