{"id":17241762,"url":"https://github.com/j256/spring-request-doclet","last_synced_at":"2026-04-24T21:31:56.803Z","repository":{"id":13885684,"uuid":"75215809","full_name":"j256/spring-request-doclet","owner":"j256","description":"Doclet that generates documentation automatically using Spring request annotations and Javadocs.","archived":false,"fork":false,"pushed_at":"2022-12-16T09:52:19.000Z","size":77,"stargazers_count":1,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-03-11T13:36:30.736Z","etag":null,"topics":["java","javadoc","spring","spring-web"],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/j256.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-11-30T18:37:40.000Z","updated_at":"2025-01-05T07:44:04.000Z","dependencies_parsed_at":"2023-01-13T17:40:00.730Z","dependency_job_id":null,"html_url":"https://github.com/j256/spring-request-doclet","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/j256/spring-request-doclet","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/j256%2Fspring-request-doclet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/j256%2Fspring-request-doclet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/j256%2Fspring-request-doclet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/j256%2Fspring-request-doclet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/j256","download_url":"https://codeload.github.com/j256/spring-request-doclet/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/j256%2Fspring-request-doclet/sbom","scorecard":{"id":499848,"data":{"date":"2025-08-11","repo":{"name":"github.com/j256/spring-request-doclet","commit":"efdace206dccfdf6ed45bfc71831f593b1456ea5"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.7,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/28 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":"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":"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":"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":"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":"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":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","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":"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":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE.txt:0","Info: FSF or OSI recognized license: ISC License: LICENSE.txt: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":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"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 2 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":"15 existing vulnerabilities detected","details":["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-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-ccgv-vj62-xf9h","Warn: Project is vulnerable to: GHSA-hgjh-9rj2-g67j","Warn: Project is vulnerable to: GHSA-g5vr-rgqm-vf78"],"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-19T21:31:57.783Z","repository_id":13885684,"created_at":"2025-08-19T21:31:57.783Z","updated_at":"2025-08-19T21:31:57.783Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32241603,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-24T13:21:15.438Z","status":"ssl_error","status_checked_at":"2026-04-24T13:21:15.005Z","response_time":64,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["java","javadoc","spring","spring-web"],"created_at":"2024-10-15T06:11:10.657Z","updated_at":"2026-04-24T21:31:56.787Z","avatar_url":"https://github.com/j256.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"This package provides a simple doclet for auto-generating documentation using Java's javadoc generator\nspecifically for tracking spring's web requests.\n\n* For more information, visit the [Spring Request Doclet home page](http://256stuff.com/sources/spring-request-doclet/).\t\n* Browse the code on the [git repository](https://github.com/j256/spring-request-doclet).\n* Maven packages are published via [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.j256.spring-request-doclet/spring-request-doclet/badge.svg?style=flat-square)](https://maven-badges.herokuapp.com/maven-central/com.j256.spring-request-doclet/spring-request-doclet/)\n\nEnjoy. Gray Watson\n\n## Sample Output\n\nFor sample output, see this hiearchy: http://256stuff.com/sources/spring-request-doclet/sample/\n\n## How to Use With Maven\n\nTo use this doclet you will need to include something like the following into your Maven pom.xml and\nexecute 'mvn site:site'.\n\n\t\u003creporting\u003e\n\t\t\u003cplugins\u003e\n\t\t\t\u003cplugin\u003e\n\t\t\t\t\u003cgroupId\u003eorg.apache.maven.plugins\u003c/groupId\u003e\n\t\t\t\t\u003cartifactId\u003emaven-javadoc-plugin\u003c/artifactId\u003e\n\t\t\t\t\u003cversion\u003e?.?.?\u003c/version\u003e\n\t\t\t\t\u003creportSets\u003e\n\t\t\t\t\t\u003creportSet\u003e\n\t\t\t\t\t\t\u003cid\u003espring-request-doclet\u003c/id\u003e\n\t\t\t\t\t\t\u003creports\u003e\n\t\t\t\t\t\t\t\u003creport\u003ejavadoc\u003c/report\u003e\n\t\t\t\t\t\t\u003c/reports\u003e\n\t\t\t\t\t\t\u003cconfiguration\u003e\n\t\t\t\t\t\t\t\u003cname\u003eSpring Request Docs\u003c/name\u003e\n\t\t\t\t\t\t\t\u003cdescription\u003eSpring Request documentation.\u003c/description\u003e\n\t\t\t\t\t\t\t\u003cdoclet\u003ecom.j256.springrequestdoclet.SpringRequestDoclet\u003c/doclet\u003e\n\t\t\t\t\t\t\t\u003cdocletArtifact\u003e\n\t\t\t\t\t\t\t\t\u003cgroupId\u003ecom.j256.spring-request-doclet\u003c/groupId\u003e\n\t\t\t\t\t\t\t\t\u003cartifactId\u003espring-request-doclet\u003c/artifactId\u003e\n\t\t\t\t\t\t\t\t\u003cversion\u003e?.?.?\u003c/version\u003e\n\t\t\t\t\t\t\t\u003c/docletArtifact\u003e\n\t\t\t\t\t\t\t\u003cuseStandardDocletOptions\u003efalse\u003c/useStandardDocletOptions\u003e\n\t\t\t\t\t\t\t\u003cdestDir\u003espring-request-docs\u003c/destDir\u003e\n\t\t\t\t\t\t\u003c/configuration\u003e\n\t\t\t\t\t\u003c/reportSet\u003e\n\t\t\t\t\u003c/reportSets\u003e\n\t\t\t\u003c/plugin\u003e\n\t\t\u003c/plugins\u003e\n\t\u003c/reporting\u003e\n\nOnce you run site:site, the directory target/site/spring-request-docs will have been created.    You can\nalso run 'mvn site:site site:jar' to package up a target/*-site.jar with the site documentation.\n\n### Optional Root Documentation\n\nBy default the doclet will generate request details which include a path summary, class summary, class\ndetails, and method details files.  If you'd like, you can specify a small hierarchy of custom\ndocumentation that can be used to provide more generic information as an introduction to the requests\nhandled as opposed to the details from the classes.\n\nTo add the custom documentation, you specificy the -r option with a relative directory path.\nSomething like:\n\n\t\u003creportSet\u003e\n\t\t\u003cid\u003espring-request-doclet\u003c/id\u003e\n\t\t...\n\t\t\u003cconfiguration\u003e\n\t\t\t\u003c!-- seems to need to be relative to target/site/spring-request-docs --\u003e\n\t\t\t\u003cadditionalparam\u003e-r ../../../src/main/doc/spring-request-doclet\u003c/additionalparam\u003e\n\t\t\t...\n\t\t\u003c/configuration\u003e\n\t\u003c/reportSet\u003e\n\nFor example, if you have:\n\n\tsrc/main/doc/spring-request-doclet/index.html\n\tsrc/main/doc/spring-request-doclet/overview/index.html\n\tsrc/main/doc/spring-request-doclet/overview/details.html\n\nthen these files will be copied into:\n\n\ttarget/site/spring-request-docs/index.html\n\ttarget/site/spring-request-docs/overview/index.html\n\ttarget/site/spring-request-docs/overview/details.html\n\nBy default the path-summary file is written to index.html but if you specify a replacement index.html\nthen it will be written to paths.html and you should include a link to it in your replacement index.\n\nThe following files are auto-generated by the doclet and should not be overwritten:\n\n\tclasses.html\n\tpaths.html\n\tclasses/\n\nAny other paths and directories can be used.\n\n# Maven Configuration\n\n* Maven packages are published via [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.j256.spring-request-doclet/spring-request-doclet/badge.svg?style=flat-square)](https://maven-badges.herokuapp.com/maven-central/com.j256.spring-request-doclet/spring-request-doclet/)\n\n``` xml\n\u003cdependency\u003e\n\t\u003cgroupId\u003ecom.j256.spring-request-doclet\u003c/groupId\u003e\n\t\u003cartifactId\u003espring-request-doclet\u003c/artifactId\u003e\n\t\u003cversion\u003e1.1\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n# ChangeLog Release Notes\n\nSee the [ChangeLog.txt file](src/main/javadoc/doc-files/changelog.txt).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fj256%2Fspring-request-doclet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fj256%2Fspring-request-doclet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fj256%2Fspring-request-doclet/lists"}