{"id":15692045,"url":"https://github.com/markbates/api_doc","last_synced_at":"2025-05-08T00:00:24.528Z","repository":{"id":2583543,"uuid":"3564684","full_name":"markbates/api_doc","owner":"markbates","description":"Easily generate API docs from RSpec/Rails","archived":false,"fork":false,"pushed_at":"2023-01-19T00:43:25.000Z","size":80,"stargazers_count":7,"open_issues_count":14,"forks_count":7,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-20T04:34:22.565Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://www.metabates.com","language":"Ruby","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/markbates.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-02-27T20:56:36.000Z","updated_at":"2023-06-04T07:04:39.000Z","dependencies_parsed_at":"2023-02-10T19:15:56.348Z","dependency_job_id":null,"html_url":"https://github.com/markbates/api_doc","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markbates%2Fapi_doc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markbates%2Fapi_doc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markbates%2Fapi_doc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markbates%2Fapi_doc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/markbates","download_url":"https://codeload.github.com/markbates/api_doc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252973674,"owners_count":21834107,"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-10-03T18:28:19.234Z","updated_at":"2025-05-08T00:00:22.125Z","avatar_url":"https://github.com/markbates.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ApiDoc\n\nA quick and easy way to generate pretty API documentation for a Rails application using your (Rspec) controller specs.\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n    gem 'api_doc'\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install api_doc\n\n## Usage\n\nPrepare your Rails project by running the generator inside your project:\n\n    rails g api_doc:install\n\nThis will copy over the appropriate assets and mount the engine routes.\n\nNext, add the following to your \u003ccode\u003espec/spec_helper.rb\u003c/spec\u003e:\n\n    require \"api_doc/rspec\"\n\nThen tag each controller spec that you want to document like so:\n\n    describe 'index' do\n      it 'returns a list of questions', :api_doc =\u003e true do\n        get :index\n        response.status.should be(200)\n      end\n    end\n\nFinally, run \u003ccode\u003erake api:doc\u003c/code\u003e command and visit /api_docs to browse the generated documentation.\n\n## Contributing\n\n1. Fork it\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Added some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create new Pull Request\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarkbates%2Fapi_doc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarkbates%2Fapi_doc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarkbates%2Fapi_doc/lists"}