{"id":37023923,"url":"https://github.com/damianwajser/spring-rest-commons-options","last_synced_at":"2026-01-14T02:52:55.036Z","repository":{"id":57719693,"uuid":"109213297","full_name":"damianwajser/spring-rest-commons-options","owner":"damianwajser","description":"This project contains the general-purpose documentation to spring rest api http options","archived":false,"fork":false,"pushed_at":"2017-12-11T23:08:24.000Z","size":673,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-07-23T04:37:40.407Z","etag":null,"topics":["http","options","options-parsing","rest","rest-api","spring","spring-boot"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/damianwajser.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":"2017-11-02T03:27:38.000Z","updated_at":"2018-06-12T18:59:12.000Z","dependencies_parsed_at":"2022-09-13T13:01:52.823Z","dependency_job_id":null,"html_url":"https://github.com/damianwajser/spring-rest-commons-options","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"purl":"pkg:github/damianwajser/spring-rest-commons-options","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/damianwajser%2Fspring-rest-commons-options","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/damianwajser%2Fspring-rest-commons-options/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/damianwajser%2Fspring-rest-commons-options/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/damianwajser%2Fspring-rest-commons-options/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/damianwajser","download_url":"https://codeload.github.com/damianwajser/spring-rest-commons-options/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/damianwajser%2Fspring-rest-commons-options/sbom","scorecard":{"id":318054,"data":{"date":"2025-08-11","repo":{"name":"github.com/damianwajser/spring-rest-commons-options","commit":"524c5c74799b0b3e42eda3455b4db5ba28748f10"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.1,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":0,"reason":"Found 0/26 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"CII-Best-Practices","score":2,"reason":"badge detected: InProgress","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 5 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"159 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-vmfg-rjjm-rjrj","Warn: Project is vulnerable to: GHSA-vmq6-5m68-f53m","Warn: Project is vulnerable to: GHSA-668q-qrv7-99fm","Warn: Project is vulnerable to: GHSA-6v67-2wr5-gvf4","Warn: Project is vulnerable to: GHSA-pr98-23f8-jwxv","Warn: Project is vulnerable to: GHSA-h46c-h94j-95f3","Warn: Project is vulnerable to: GHSA-wf8f-6423-gfxg","Warn: Project is vulnerable to: GHSA-27xj-rqx5-2255","Warn: Project is vulnerable to: GHSA-288c-cq4h-88gq","Warn: Project is vulnerable to: GHSA-4gq5-ch57-c2mg","Warn: Project is vulnerable to: GHSA-4w82-r329-3q67","Warn: Project is vulnerable to: GHSA-57j2-w4cx-62h2","Warn: Project is vulnerable to: GHSA-58pp-9c76-5625","Warn: Project is vulnerable to: GHSA-5949-rw7g-wx7w","Warn: Project is vulnerable to: GHSA-5p34-5m6p-p58g","Warn: Project is vulnerable to: GHSA-5r5r-6hpj-8gg9","Warn: Project is vulnerable to: GHSA-5ww9-j83m-q7qx","Warn: Project is vulnerable to: GHSA-645p-88qh-w398","Warn: Project is vulnerable to: GHSA-6fpp-rgj9-8rwc","Warn: Project is vulnerable to: GHSA-6wqp-v4v6-c87c","Warn: Project is vulnerable to: GHSA-758m-v56v-grj4","Warn: Project is vulnerable to: GHSA-85cw-hj65-qqv9","Warn: Project is vulnerable to: GHSA-89qr-369f-5m5x","Warn: Project is vulnerable to: GHSA-8c4j-34r4-xr8g","Warn: Project is vulnerable to: GHSA-8w26-6f25-cm9x","Warn: Project is vulnerable to: GHSA-95cm-88f5-f2c7","Warn: Project is vulnerable to: GHSA-9gph-22xh-8x98","Warn: Project is vulnerable to: GHSA-9m6f-7xcq-8vf8","Warn: Project is vulnerable to: GHSA-9mxf-g3x6-wv74","Warn: Project is vulnerable to: GHSA-9vvp-fxw6-jcxr","Warn: Project is vulnerable to: GHSA-c265-37vj-cwcc","Warn: Project is vulnerable to: GHSA-c2q3-4qrh-fm48","Warn: Project is vulnerable to: GHSA-c8hm-7hpq-7jhg","Warn: Project is vulnerable to: GHSA-cf6r-3wgc-h863","Warn: Project is vulnerable to: GHSA-cggj-fvv3-cqwv","Warn: Project is vulnerable to: GHSA-cjjf-94ff-43w7","Warn: Project is vulnerable to: GHSA-cmfg-87vq-g5g4","Warn: Project is vulnerable to: GHSA-cvm9-fjm9-3572","Warn: Project is vulnerable to: GHSA-f3j5-rmmp-3fc5","Warn: Project is vulnerable to: GHSA-f9hv-mg5h-xcw9","Warn: Project is vulnerable to: GHSA-f9xh-2qgp-cq57","Warn: Project is vulnerable to: GHSA-fmmc-742q-jg75","Warn: Project is vulnerable to: GHSA-fqwf-pjwf-7vqv","Warn: Project is vulnerable to: GHSA-gjmw-vf9h-g25v","Warn: Project is vulnerable to: GHSA-gwp4-hfv6-p7hw","Warn: Project is vulnerable to: GHSA-gww7-p5w4-wrfv","Warn: Project is vulnerable to: GHSA-h3cw-g4mq-c5x2","Warn: Project is vulnerable to: GHSA-h4rc-386g-6m85","Warn: Project is vulnerable to: GHSA-h592-38cm-4ggp","Warn: Project is vulnerable to: GHSA-h822-r4r5-v8jg","Warn: Project is vulnerable to: GHSA-j823-4qch-3rgm","Warn: Project is vulnerable to: GHSA-jjjh-jjxp-wpff","Warn: Project is vulnerable to: GHSA-m6x4-97wx-4q27","Warn: Project is vulnerable to: GHSA-mc6h-4qgp-37qh","Warn: Project is vulnerable to: GHSA-mph4-vhrx-mv67","Warn: Project is vulnerable to: GHSA-mx7p-6679-8g3q","Warn: Project is vulnerable to: GHSA-mx9v-gmh4-mgqw","Warn: Project is vulnerable to: GHSA-p43x-xfjf-5jhr","Warn: Project is vulnerable to: GHSA-q93h-jc49-78gg","Warn: Project is vulnerable to: GHSA-qjw2-hr98-qgfh","Warn: Project is vulnerable to: GHSA-qmqc-x3r4-6v39","Warn: Project is vulnerable to: GHSA-qr7j-h6gg-jmgc","Warn: Project is vulnerable to: GHSA-r3gr-cxrf-hg25","Warn: Project is vulnerable to: GHSA-r695-7vr9-jgc2","Warn: Project is vulnerable to: GHSA-rf6r-2c4q-2vwg","Warn: Project is vulnerable to: GHSA-rfx6-vp9g-rh7v","Warn: Project is vulnerable to: GHSA-rgv9-q543-rqg4","Warn: Project is vulnerable to: GHSA-rpr3-cw39-3pxh","Warn: Project is vulnerable to: GHSA-v3xw-c963-f5hc","Warn: Project is vulnerable to: GHSA-v585-23hc-c647","Warn: Project is vulnerable to: GHSA-vfqx-33qm-g869","Warn: Project is vulnerable to: GHSA-w3f4-3q6j-rh82","Warn: Project is vulnerable to: GHSA-wh8g-3j2c-rqj5","Warn: Project is vulnerable to: GHSA-x2w5-5m2g-7h5m","Warn: Project is vulnerable to: GHSA-pfh2-hfmq-phg5","Warn: Project is vulnerable to: GHSA-6hgm-866r-3cjv","Warn: Project is vulnerable to: GHSA-fjq5-5j5f-mvxh","Warn: Project is vulnerable to: GHSA-6pcc-3rfx-4gpm","Warn: Project is vulnerable to: GHSA-hwj3-m3p6-hj38","Warn: Project is vulnerable to: GHSA-269g-pwp5-87pp","Warn: Project is vulnerable to: GHSA-493p-pfq6-5258","Warn: Project is vulnerable to: GHSA-v528-7hrm-frqp","Warn: Project is vulnerable to: GHSA-j288-q9x7-2f5v","Warn: Project is vulnerable to: GHSA-2rvv-w9r2-rg7m","Warn: Project is vulnerable to: GHSA-3p2h-wqq4-wf4h","Warn: Project is vulnerable to: GHSA-46j3-r4pj-4835","Warn: Project is vulnerable to: GHSA-5j33-cvvr-w245","Warn: Project is vulnerable to: GHSA-5q99-f34m-67gc","Warn: Project is vulnerable to: GHSA-6rxj-58jh-436r","Warn: Project is vulnerable to: GHSA-6v52-mj5r-7j2m","Warn: Project is vulnerable to: GHSA-7w75-32cg-r6g2","Warn: Project is vulnerable to: GHSA-83qj-6fr2-vhqg","Warn: Project is vulnerable to: GHSA-8vmx-qmch-mpqg","Warn: Project is vulnerable to: GHSA-9xcj-c8cr-8c3c","Warn: Project is vulnerable to: GHSA-c9hw-wf7x-jp9j","Warn: Project is vulnerable to: GHSA-f4qf-m5gf-8jm8","Warn: Project is vulnerable to: GHSA-fccv-jmmp-qg76","Warn: Project is vulnerable to: GHSA-ff77-26x5-69cr","Warn: Project is vulnerable to: GHSA-g8pj-r55q-5c2v","Warn: Project is vulnerable to: GHSA-h2fw-rfh5-95r3","Warn: Project is vulnerable to: GHSA-h3gc-qfqq-6h8f","Warn: Project is vulnerable to: GHSA-hh3j-x4mc-g48r","Warn: Project is vulnerable to: GHSA-j39c-c8hj-x4j3","Warn: Project is vulnerable to: GHSA-jgwr-3qm3-26f3","Warn: Project is vulnerable to: GHSA-jjpq-gp5q-8q6w","Warn: Project is vulnerable to: GHSA-jx6h-3fjx-cgv5","Warn: Project is vulnerable to: GHSA-m59c-jpc8-m2x4","Warn: Project is vulnerable to: GHSA-p22x-g9px-3945","Warn: Project is vulnerable to: GHSA-q3mw-pvr8-9ggc","Warn: Project is vulnerable to: GHSA-q4hg-rmq2-52q9","Warn: Project is vulnerable to: GHSA-qcxh-w3j9-58qr","Warn: Project is vulnerable to: GHSA-qppj-fm5r-hxr3","Warn: Project is vulnerable to: GHSA-qxf4-chvg-4r8r","Warn: Project is vulnerable to: GHSA-r4x2-3cq5-hqvp","Warn: Project is vulnerable to: GHSA-r6j3-px5g-cq3x","Warn: Project is vulnerable to: GHSA-wc4r-xq3c-5cf3","Warn: Project is vulnerable to: GHSA-wm9w-rjj3-j356","Warn: Project is vulnerable to: GHSA-v682-8vv8-vpwr","Warn: Project is vulnerable to: GHSA-7v6m-28jr-rg84","Warn: Project is vulnerable to: GHSA-m8p2-495h-ccmh","Warn: Project is vulnerable to: GHSA-rmrm-75hp-phr2","Warn: Project is vulnerable to: GHSA-x83m-pf6f-pf9g","Warn: Project is vulnerable to: GHSA-8grg-q944-cch5","Warn: Project is vulnerable to: GHSA-j8jw-g6fq-mp7h","Warn: Project is vulnerable to: GHSA-xxgp-pcfc-3vgc","Warn: Project is vulnerable to: GHSA-cm59-pr5q-cw85","Warn: Project is vulnerable to: GHSA-rc42-6c7j-7h5r","Warn: Project is vulnerable to: GHSA-xx65-cc7g-9pfp","Warn: Project is vulnerable to: GHSA-xf96-w227-r7c4","Warn: Project is vulnerable to: GHSA-36p3-wjmg-h94x","Warn: Project is vulnerable to: GHSA-hh26-6xwr-ggv7","Warn: Project is vulnerable to: GHSA-4gc7-5j7h-4qph","Warn: Project is vulnerable to: GHSA-4wp7-92pw-q264","Warn: Project is vulnerable to: GHSA-g5mm-vmx4-3rg7","Warn: Project is vulnerable to: GHSA-4487-x383-qpph","Warn: Project is vulnerable to: GHSA-f26x-pr96-vw86","Warn: Project is vulnerable to: GHSA-ffvq-7w96-97p7","Warn: Project is vulnerable to: GHSA-g8hw-794c-4j9g","Warn: Project is vulnerable to: GHSA-rcpf-vj53-7h2m","Warn: Project is vulnerable to: GHSA-v596-fwhq-8x48","Warn: Project is vulnerable to: GHSA-558x-2xjg-6232","Warn: Project is vulnerable to: GHSA-564r-hj7v-mcr5","Warn: Project is vulnerable to: GHSA-9cmq-m9j5-mvww","Warn: Project is vulnerable to: GHSA-wxqc-pxw9-g2p8","Warn: Project is vulnerable to: GHSA-2rmj-mq67-h97g","Warn: Project is vulnerable to: GHSA-2wrp-6fg6-hmc5","Warn: Project is vulnerable to: GHSA-4wrc-f8pq-fpqp","Warn: Project is vulnerable to: GHSA-9gcm-f4x3-8jpw","Warn: Project is vulnerable to: GHSA-ccgv-vj62-xf9h","Warn: Project is vulnerable to: GHSA-hgjh-9rj2-g67j","Warn: Project is vulnerable to: GHSA-g5vr-rgqm-vf78","Warn: Project is vulnerable to: GHSA-3mc7-4q67-w48m","Warn: Project is vulnerable to: GHSA-98wm-3w3q-mw94","Warn: Project is vulnerable to: GHSA-9w3m-gqgf-c4p9","Warn: Project is vulnerable to: GHSA-c4r9-r8fh-9vj2","Warn: Project is vulnerable to: GHSA-hhhw-99gj-p3c3","Warn: Project is vulnerable to: GHSA-mjmj-j48q-9wg2","Warn: Project is vulnerable to: GHSA-rvwf-54qp-4r6v","Warn: Project is vulnerable to: GHSA-w37g-rhq8-7m4j"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-18T00:42:52.875Z","repository_id":57719693,"created_at":"2025-08-18T00:42:52.875Z","updated_at":"2025-08-18T00:42:52.875Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28408789,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T01:52:23.358Z","status":"online","status_checked_at":"2026-01-14T02:00:06.678Z","response_time":107,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["http","options","options-parsing","rest","rest-api","spring","spring-boot"],"created_at":"2026-01-14T02:52:54.326Z","updated_at":"2026-01-14T02:52:55.025Z","avatar_url":"https://github.com/damianwajser.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# spring-rest-commons-options\n\n\u003cp align=\"center\"\u003e\u003cimg src=\"/images/Logo.png\" width=\"100\" height=\"80\"\u003e\u003cp\u003e \n\n[![Build Status](https://travis-ci.org/damianwajser/spring-rest-commons-options.svg?branch=master)](https://travis-ci.org/damianwajser/spring-rest-commons-options) [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/1400/badge)](https://bestpractices.coreinfrastructure.org/projects/1400) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.damianwajser/spring-rest-commons-options/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.github.damianwajser/spring-rest-commons-options) [![Maintainability](https://api.codeclimate.com/v1/badges/dc020f5455c0b6f31089/maintainability)](https://codeclimate.com/github/damianwajser/spring-rest-commons-options/maintainability) [![Test Coverage](https://sonarcloud.io/api/badges/measure?key=com.github.damianwajser:spring-rest-commons-options\u0026metric=coverage)](https://sonarcloud.io/dashboard?id=com.github.damianwajser%3Aspring-rest-commons-options)\n[![Vulnerabilities](https://sonarcloud.io/api/badges/measure?key=com.github.damianwajser:spring-rest-commons-options\u0026metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=com.github.damianwajser%3Aspring-rest-commons-options)\n\n## Overview\n\nThis project contains the general-purpose documentation to spring rest api http options.\nProject is licensed under [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0).\n\n-----\n## Roadmap\n\nConsult the proyect for details on the current [spring-rest-commons-options roadmap](https://github.com/damianwajser/spring-rest-commons-options/projects/1).\n\n## Get it!\n\n### Install\n#### Maven\nFunctionality of this package is contained in Java package `com.github.damianwajser`, and can be used using following Maven dependency:\n\n```xml\n\u003cproperties\u003e\n  ...\n  \u003c!-- Use the latest version whenever possible. --\u003e\n  \u003coptions.spring.docs\u003e{lastversion}\u003c/options.spring.docs\u003e\n  ...\n\u003c/properties\u003e\n\n\u003cdependencies\u003e\n  ...\n  \u003cdependency\u003e\n    \u003cgroupId\u003ecom.github.damianwajser\u003c/groupId\u003e\n    \u003cartifactId\u003espring-rest-commons-options\u003c/artifactId\u003e\n    \u003cversion\u003e${options.spring.docs}\u003c/version\u003e\n  \u003c/dependency\u003e\n  ...\n\u003c/dependencies\u003e\n```\n#### Gradle\n\n```xml\ncompile 'com.github.damianwajser:spring-rest-commons-options:0.0.17'\n```\n## Usage\n\nCreate a spring-boot application.\n\n```java\n//declare the package to create de options controllers\n@ComponentScan({\"com.github.damianwajser\",\"{YOUR-PINCIPAL-PACKAGE}\"})\n@SpringBootApplication\npublic class Application {\n\n\tpublic static void main(String[] args) {\n\t\tSpringApplication.run(Application.class, args);\n\t}\n  \n}\n```\n\n### Example\n\nCreate the model, if you required, add the validation with the hibernate-validators or java-validators:\n\n```java\npublic class Example {\n\t@NotEmpty(message = \"The field description is required\")\n\tprivate String description;\n\n\tpublic String getDescription() {\n\t\treturn description;\n\t}\n\n\tpublic void setDescription(String description) {\n\t\tthis.description = description;\n\t}\n\n}\n```\n\nCreate a Controller:\n```java\n@RestController\n@RequestMapping(\"/example\")\npublic class ExapmleResource {\n\t\n\t@GetMapping(\"/{id}\")\n\tpublic Example getById(@PathVariable(\"id\") Integer id) {\n\t\tExample example = new Example();\n\t\texample.setDescription(\"description\");\n\t\treturn example;\n\n\t}\n\t\n\t@PostMapping(\"/\")\n\tpublic Example post(@Valid Example example) {\n\t\treturn example;\n\n\t}\n}\n```\n\nFull example: https://github.com/damianwajser/spring-rest-commons-options-example\n\n### Test It!!\n\nThe firts enpooint created:\n\n```curl \ncurl -X GET http://localhost:8080/endpoints\n```\n\nThe response: \n```js\n[\"/example\",\"/endpoints\"]\n```\n#### Check options\n```curl\ncurl -X OPTIONS http://localhost:8080/example\n```\nResponse:\n```js\n{\n    \"resources\": {\n        \"/example\": {\n            \"endpoints\": [\n                {\n                    \"endpoint\": \"GET - /example/{id}\",\n                    \"httpMethod\": \"GET\",\n                    \"relativeUrl\": \"/{id}\",\n                    \"queryString\": {\n                        \"params\": []\n                    },\n                    \"pathVariable\": {\n                        \"params\": [\n                            {\n                                \"required\": true,\n                                \"name\": \"id\",\n                                \"type\": \"Integer\"\n                            }\n                        ]\n                    },\n                    \"bodyRequest\": {\n                        \"fields\": [],\n                        \"jsonSchema\": null\n                    },\n                    \"bodyResponse\": {\n                        \"fields\": [\n                            {\n                                \"name\": \"description\",\n                                \"type\": \"String\",\n                                \"auditable\": false\n                            }\n                        ],\n                        \"jsonSchema\": {\n                            \"type\": \"object\",\n                            \"id\": \"urn:jsonschema:com:test:damianwajser:model:Example\",\n                            \"properties\": {\n                                \"description\": {\n                                    \"type\": \"string\"\n                                }\n                            }\n                        }\n                    },\n                    \"headers\": [],\n                    \"url\": \"/example/{id}\"\n                },\n                {\n                    \"endpoint\": \"GET - /example/{id}\",\n                    \"httpMethod\": \"GET\",\n                    \"relativeUrl\": \"/{id}\",\n                    \"queryString\": {\n                        \"params\": []\n                    },\n                    \"pathVariable\": {\n                        \"params\": [\n                            {\n                                \"required\": true,\n                                \"name\": \"id\",\n                                \"type\": \"Integer\"\n                            }\n                        ]\n                    },\n                    \"bodyRequest\": {\n                        \"fields\": [],\n                        \"jsonSchema\": null\n                    },\n                    \"bodyResponse\": {\n                        \"fields\": [\n                            {\n                                \"name\": \"description\",\n                                \"type\": \"String\",\n                                \"auditable\": false\n                            }\n                        ],\n                        \"jsonSchema\": {\n                            \"type\": \"object\",\n                            \"id\": \"urn:jsonschema:com:test:damianwajser:model:Example\",\n                            \"properties\": {\n                                \"description\": {\n                                    \"type\": \"string\"\n                                }\n                            }\n                        }\n                    },\n                    \"headers\": [],\n                    \"url\": \"/example/{id}\"\n                },\n                {\n                    \"endpoint\": \"POST - /example\",\n                    \"httpMethod\": \"POST\",\n                    \"relativeUrl\": \"\",\n                    \"queryString\": {\n                        \"params\": []\n                    },\n                    \"pathVariable\": {\n                        \"params\": []\n                    },\n                    \"bodyRequest\": {\n                        \"fields\": [\n                            {\n                                \"name\": \"description\",\n                                \"type\": \"String\",\n                                \"auditable\": false,\n                                \"validation\": [\n                                    {\n                                        \"name\": \"NotEmpty\",\n                                        \"message\": \"The field description is required\"\n                                    }\n                                ]\n                            }\n                        ],\n                        \"jsonSchema\": {\n                            \"type\": \"object\",\n                            \"id\": \"urn:jsonschema:com:test:damianwajser:model:Example\",\n                            \"properties\": {\n                                \"description\": {\n                                    \"type\": \"string\"\n                                }\n                            }\n                        }\n                    },\n                    \"bodyResponse\": {\n                        \"fields\": [\n                            {\n                                \"name\": \"description\",\n                                \"type\": \"String\",\n                                \"auditable\": false\n                            }\n                        ],\n                        \"jsonSchema\": {\n                            \"type\": \"object\",\n                            \"id\": \"urn:jsonschema:com:test:damianwajser:model:Example\",\n                            \"properties\": {\n                                \"description\": {\n                                    \"type\": \"string\"\n                                }\n                            }\n                        }\n                    },\n                    \"headers\": [],\n                    \"url\": \"/example\"\n                },\n                {\n                    \"endpoint\": \"POST - /example\",\n                    \"httpMethod\": \"POST\",\n                    \"relativeUrl\": \"\",\n                    \"queryString\": {\n                        \"params\": []\n                    },\n                    \"pathVariable\": {\n                        \"params\": []\n                    },\n                    \"bodyRequest\": {\n                        \"fields\": [\n                            {\n                                \"name\": \"description\",\n                                \"type\": \"String\",\n                                \"auditable\": false,\n                                \"validation\": [\n                                    {\n                                        \"name\": \"NotEmpty\",\n                                        \"message\": \"The field description is required\"\n                                    }\n                                ]\n                            }\n                        ],\n                        \"jsonSchema\": {\n                            \"type\": \"object\",\n                            \"id\": \"urn:jsonschema:com:test:damianwajser:model:Example\",\n                            \"properties\": {\n                                \"description\": {\n                                    \"type\": \"string\"\n                                }\n                            }\n                        }\n                    },\n                    \"bodyResponse\": {\n                        \"fields\": [\n                            {\n                                \"name\": \"description\",\n                                \"type\": \"String\",\n                                \"auditable\": false\n                            }\n                        ],\n                        \"jsonSchema\": {\n                            \"type\": \"object\",\n                            \"id\": \"urn:jsonschema:com:test:damianwajser:model:Example\",\n                            \"properties\": {\n                                \"description\": {\n                                    \"type\": \"string\"\n                                }\n                            }\n                        }\n                    },\n                    \"headers\": [],\n                    \"url\": \"/example\"\n                }\n            ]\n        }\n    },\n    \"httpCodes\": {}\n}\n```\n## License\n\nThe Spring Framework is released under version 2.0 of the\n[Apache License](http://www.apache.org/licenses/LICENSE-2.0).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdamianwajser%2Fspring-rest-commons-options","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdamianwajser%2Fspring-rest-commons-options","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdamianwajser%2Fspring-rest-commons-options/lists"}