{"id":27197713,"url":"https://github.com/preaction/yancy-plugin-openapi","last_synced_at":"2025-10-26T00:34:12.678Z","repository":{"id":56840216,"uuid":"423259218","full_name":"preaction/Yancy-Plugin-OpenAPI","owner":"preaction","description":"Generate OpenAPI schema from a database (via Yancy::Model)","archived":false,"fork":false,"pushed_at":"2021-10-31T21:14:24.000Z","size":25,"stargazers_count":0,"open_issues_count":4,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-04-17T21:17:03.875Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Perl","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/preaction.png","metadata":{"files":{"readme":"README.mkdn","changelog":"CHANGES","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-10-31T20:59:26.000Z","updated_at":"2024-04-17T21:17:03.876Z","dependencies_parsed_at":"2022-08-29T01:51:08.895Z","dependency_job_id":null,"html_url":"https://github.com/preaction/Yancy-Plugin-OpenAPI","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/preaction%2FYancy-Plugin-OpenAPI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/preaction%2FYancy-Plugin-OpenAPI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/preaction%2FYancy-Plugin-OpenAPI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/preaction%2FYancy-Plugin-OpenAPI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/preaction","download_url":"https://codeload.github.com/preaction/Yancy-Plugin-OpenAPI/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248106808,"owners_count":21048799,"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":"2025-04-09T20:29:25.524Z","updated_at":"2025-10-26T00:34:12.593Z","avatar_url":"https://github.com/preaction.png","language":"Perl","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NAME\n\nYancy::Plugin::OpenAPI - Generate an OpenAPI spec and API for a Yancy schema\n\n# VERSION\n\nversion 0.002\n\n# SYNOPSIS\n\n    use Mojolicious::Lite;\n    plugin Yancy =\u003e 'sqlite:data.db';\n    plugin OpenAPI =\u003e { route =\u003e '/api' };\n    app-\u003estart;\n\n# DESCRIPTION\n\nThis plugin generates an OpenAPI specification from your database\nschema. The generated spec has endpoints to create, read, update,\ndelete, and search for items in your database.\n\n# CONFIGURATION\n\nThese configuration keys can be part of the hash reference passed to the\n`plugin` call.\n\n## route\n\nThe base route path for the generated API. Can be a string or\na [Mojolicious::Routes](https://metacpan.org/pod/Mojolicious::Routes) object.\n\n## title\n\nThe title of the API, used in the OpenAPI spec. See also [\"info\"](#info).\n\n## info\n\nThe `info` section of the OpenAPI spec. A hash reference.\n\n## host\n\nThe host key of the OpenAPI spec. Defaults to the value of\n[\"hostname\" in Sys::Hostname](https://metacpan.org/pod/Sys::Hostname#hostname).\n\n## model\n\nThe [Yancy::Model](https://metacpan.org/pod/Yancy::Model) object to use. Defaults to\n[\"model\" in Mojolicious::Plugin::Yancy](https://metacpan.org/pod/Mojolicious::Plugin::Yancy#model).\n\n## default\\_controller\n\nThe default controller to use for generated API routes. Defaults to\n`yancy`, the [Yancy::Controller::Yancy](https://metacpan.org/pod/Yancy::Controller::Yancy) controller.\n\n# SEE ALSO\n\n[Mojolicious::Plugin::OpenAPI](https://metacpan.org/pod/Mojolicious::Plugin::OpenAPI), [Yancy](https://metacpan.org/pod/Yancy)\n\n# AUTHOR\n\nDoug Bell \u003cpreaction@cpan.org\u003e\n\n# COPYRIGHT AND LICENSE\n\nThis software is copyright (c) 2021 by Doug Bell.\n\nThis is free software; you can redistribute it and/or modify it under\nthe same terms as the Perl 5 programming language system itself.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpreaction%2Fyancy-plugin-openapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpreaction%2Fyancy-plugin-openapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpreaction%2Fyancy-plugin-openapi/lists"}