{"id":13623681,"url":"https://bshaffer.github.io/oauth2-server-php-docs/","last_synced_at":"2025-04-15T15:30:37.319Z","repository":{"id":9525553,"uuid":"11425412","full_name":"bshaffer/oauth2-server-php-docs","owner":"bshaffer","description":"documentation for the oauth2-server-php library","archived":false,"fork":false,"pushed_at":"2023-10-02T19:53:43.000Z","size":1139,"stargazers_count":230,"open_issues_count":48,"forks_count":148,"subscribers_count":24,"default_branch":"master","last_synced_at":"2025-04-05T14:09:07.712Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"CSS","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/bshaffer.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}},"created_at":"2013-07-15T14:42:03.000Z","updated_at":"2025-03-15T20:58:44.000Z","dependencies_parsed_at":"2024-01-20T16:49:16.468Z","dependency_job_id":"bea82596-ecf0-490a-abb1-123480321ddb","html_url":"https://github.com/bshaffer/oauth2-server-php-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bshaffer%2Foauth2-server-php-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bshaffer%2Foauth2-server-php-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bshaffer%2Foauth2-server-php-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bshaffer%2Foauth2-server-php-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bshaffer","download_url":"https://codeload.github.com/bshaffer/oauth2-server-php-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249097731,"owners_count":21212343,"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-08-01T21:01:34.484Z","updated_at":"2025-04-15T15:30:36.895Z","avatar_url":"https://github.com/bshaffer.png","language":"CSS","readme":"# OAuth2 Server PHP Documentation\n\nThis repository hosts the [documentation](http://bshaffer.github.io/oauth2-server-php-docs/) for the\n[oauth2-server-php](https://github.com/bshaffer/oauth2-server-php) library.\n\nAll submissions are welcome! To submit a change, fork this repo and send us a [pull request](http://help.github.com/send-pull-requests/).\n\n## Setup\n\nRuby 1.9 is required to build the site.\n\nGet the nanoc gem, plus kramdown for markdown parsing:\n\n    bundle install\n\nCompile the src into the `output` directory by running the following command:\n\n    nanoc compile\n\nYou can see the available commands with nanoc:\n\n    nanoc -h\n\nNanoc has [some nice documentation](http://nanoc.stoneship.org/docs/3-getting-started/) to get you started.  Though if you're mainly concerned with editing or adding content, you won't need to know much about nanoc.\n\n## Development\n\nNanoc compiles the site into static files living in `./output`.  It's\nsmart enough not to try to compile unchanged files:\n\n    $ nanoc compile\n    Loading site data...\n    Compiling site...\n       identical  [0.00s]  output/css/960.css\n       identical  [0.00s]  output/css/pygments.css\n       identical  [0.00s]  output/css/reset.css\n       identical  [0.00s]  output/css/styles.css\n       identical  [0.00s]  output/css/uv_active4d.css\n          update  [0.28s]  output/index.html\n\n    Site compiled in 5.81s.\n\nYou can setup whatever you want to view the files.  If you have the adsf\ngem, however (I hope so, it was in the Gemfile), you can start Webrick:\n\n    $ nanoc view\n    $ open http://localhost:3000\n\nCompilation times got you down?  Use `autocompile`!\n\n    $ nanoc autocompile\n\nThis starts a web server too, so there's no need to run `nanoc view`.\nOne thing: remember to add trailing slashes to all nanoc links!\n\n## Deploy\n\n    $ rake publish\n\n## Styleguide\n\nNot sure how to structure the docs?  Here's what the structure of the\nAPI docs should look like:\n\n    # API title\n\n    ## API endpoint title\n\n        [VERB] /path/to/endpoint.json\n\n    ### Parameters\n\n    name\n    : description\n\n    ### Input (request json body)\n\n    \u003c%= json :field =\u003e \"sample value\" %\u003e\n\n    ### Response\n\n    \u003c%= headers 200, :pagination =\u003e true, 'X-Custom-Header' =\u003e \"value\" %\u003e\n    \u003c%= json :resource_name %\u003e\n\n**Note**: We're using [Kramdown Markdown extensions](http://kramdown.rubyforge.org/syntax.html), such as definition lists.\n\n### JSON Responses\n\nWe specify the JSON responses in ruby so that we don't have to write\nthem by hand all over the docs.  You can render the JSON for a resource\nlike this:\n\n```erb\n\u003c%= json :issue %\u003e\n```\n\nThis looks up `GitHub::Resources::ISSUE` in `lib/resources.rb`.\n\nSome actions return arrays.  You can modify the JSON by passing a block:\n\n```erb\n\u003c%= json(:issue) { |hash| [hash] } %\u003e\n```\n\n### Terminal blocks\n\nYou can specify terminal blocks with `pre.terminal` elements.  It'd be\nnice if Markdown could do this more cleanly...\n\n    \u003cpre class=\"terminal\"\u003e\n    $ curl foobar\n    ....\n    \u003c/pre\u003e\n\nThis isn't a `curl` tutorial though, I'm not sure every API call needs\nto show how to access it with `curl`.\n\n","funding_links":[],"categories":["Table of Contents","目录","PHP"],"sub_categories":["Authentication and Authorization","身份验证和授权 Authentication and Authorization"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/bshaffer.github.io%2Foauth2-server-php-docs%2F","html_url":"https://awesome.ecosyste.ms/projects/bshaffer.github.io%2Foauth2-server-php-docs%2F","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/bshaffer.github.io%2Foauth2-server-php-docs%2F/lists"}