{"id":25569506,"url":"https://github.com/restx/restx","last_synced_at":"2025-12-17T18:57:10.232Z","repository":{"id":43843406,"uuid":"9836833","full_name":"restx/restx","owner":"restx","description":"RESTX, the lightweight Java REST framework","archived":false,"fork":false,"pushed_at":"2025-10-03T10:19:41.000Z","size":9739,"stargazers_count":446,"open_issues_count":41,"forks_count":79,"subscribers_count":42,"default_branch":"master","last_synced_at":"2025-10-03T12:10:38.741Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://restx.io","language":"Java","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/restx.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2013-05-03T13:49:40.000Z","updated_at":"2025-08-13T11:10:43.000Z","dependencies_parsed_at":"2022-09-07T09:21:24.850Z","dependency_job_id":"29b70ecc-4f5d-440d-baf3-b13189ea77e5","html_url":"https://github.com/restx/restx","commit_stats":null,"previous_names":[],"tags_count":39,"template":false,"template_full_name":null,"purl":"pkg:github/restx/restx","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/restx%2Frestx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/restx%2Frestx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/restx%2Frestx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/restx%2Frestx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/restx","download_url":"https://codeload.github.com/restx/restx/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/restx%2Frestx/sbom","scorecard":{"id":772138,"data":{"date":"2025-08-11","repo":{"name":"github.com/restx/restx","commit":"229b6d7e3d4de14b8575b24d20f717f29879b5cf"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.3,"checks":[{"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":"Code-Review","score":0,"reason":"Found 0/30 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":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/restx-ci.yml:1","Info: no jobLevel write permissions found"],"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":"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":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"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":"License","score":9,"reason":"license file detected","details":["Info: project has a license file: LICENSE.txt:0","Warn: project license file does not contain an FSF or OSI license."],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Binary-Artifacts","score":9,"reason":"binaries present in source code","details":["Warn: binary detected: .mvn/wrapper/maven-wrapper.jar:1"],"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":"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":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/restx-ci.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/restx/restx/restx-ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/restx-ci.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/restx/restx/restx-ci.yml/master?enable=pin","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned"],"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":"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":"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":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"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-23T02:29:23.954Z","repository_id":43843406,"created_at":"2025-08-23T02:29:23.954Z","updated_at":"2025-08-23T02:29:23.954Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27785543,"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","status":"online","status_checked_at":"2025-12-17T02:00:08.291Z","response_time":55,"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":[],"created_at":"2025-02-21T00:02:27.717Z","updated_at":"2025-12-17T18:57:10.225Z","avatar_url":"https://github.com/restx.png","language":"Java","funding_links":[],"categories":["开发框架"],"sub_categories":[],"readme":"# RESTX - the lightweight Java REST framework\n\n[![Build Status](https://github.com/restx/restx/actions/workflows/restx-ci.yml/badge.svg?branch=master)](https://github.com/restx/restx/actions/workflows/restx-ci.yml)\n\nRESTX is a full lightweight disrupting stack, which includes Swagger-like ui \u0026 considers REST specs tests as docs.\n\nIt shares similarities with modern frameworks like Play! like hot compile and a very productive experience, but focused on REST and pure Java.\n\nIt's licensed under the very commercial friendly Apache License 2, and is actively maintained by a community of developers.\n\nYou can get more details from the web site at http://restx.io/\n\nHere you will find the build instructions if you want to build RESTX yourself, and why not contribute to the project.\n\n## Build\n\nRESTX requires Java 17.\n\nYou can build it using either Maven Wrapper.\n\nWith Maven:\n\n`./mvnw install`\n\n## Project organisation\n\nRESTX is decomposed in a set of modules, each one following the traditional Java project layout (main sources in `src/main`, test sources in `src/test`).\n\nThe main modules are `restx-core` and `restx-factory`.\n\nHere is a brief summary of each module:\n\n### Main modules:\n\n- `restx-common`: Some shared utilities, only few ones, relying on Guava we already get a lot of nice utilities from there.\n- `restx-factory`: RESTX Dependency Injection (DI) container. Brought as transitive dependency from restx-core.\n- `restx-classloader`: Hot reload / hot compile support\n- `restx-apidocs-doclet`: Some javadoc doclets used when generating apidocs\n- `restx-core`: Core module, includes the REST framework, base security, JSON support, ...\n\n*By relying on `restx-core` module, every modules described above will be retrieved as transitive dependencies*\n\n- `restx-core-annotation-processor`: Annotation processing to generate routers based on RESTX core annotations. Needed at compile/build time only.\n\n\n### Optional dependencies providing specific features\n\n- `restx-i18n`: I18n Support\n- `restx-security-basic`: A basic implementation of security, still enough in many cases but you can remove it at will\n- `restx-specs-tests`: Enables using RESTX specs as JUnit tests.\n- `restx-specs-server`: Enables using RESTX specs as HTTP mocks (running a server serving spec files responses given spec files requests).\n- `restx-factory-testing`: A module dedicated to test `restx-factory` features involving annotation processing.\n- `restx-validation`: Bean validation support (based on `hibernate-validator` implementation) for POJOs BODY parameters\n- `restx-webjars`: Webjars support through urls like `/@/webjars/*`\n\n\n#### MongoDB support through Jongo API:\n\n- `restx-jongo`: Main MongoDB support through Jongo API.\n- `restx-jongo-specs-tests`: Support of Jongo in your specs (recording and running).\n\n\n#### Admin console modules (these are not required modules and are intended only for administration/monitoring) :\n\n- `restx-admin`: The pluggable RESTX admin web console.\n- `restx-apidocs`: The famous API Docs web console, as a plugin for `restx-admin`.\n- `restx-monitor-admin`: Poor's man app monitoring web console, plugin for `restx-admin`.\n- `restx-factory-admin`: RESTX Factory admin console, plugin for `restx-admin`.\n- `restx-log-admin`: Easy configuration of logback logging from admin console, plugin for `restx-admin`.\n- `restx-specs-admin`: RESTX Specs recording and running web console, plugin for `restx-admin`.\n- `restx-i18n-admin`: Easy setting of your i18n translations from the web console, plugin for `restx-admin`.\n- `restx-stats-admin`: Used to collect stats as explained [here](http://restx.io/stats.html)\n\n\n### Servers support:\n\n- `restx-servlet`: Servlet 6+ adapter for RESTX, allowing to embed RESTX in any servlet 5+ container.\n- `restx-server-jetty`: Embedded Jetty 12 support.\n- `restx-server-tomcat`: Embedded Tomcat 10.1 support.\n- `restx-server-simple`: SimpleFramework adapter for RESTX, this is the lightest and fastest solution.\n- `restx-server-testing`: JUnit tests for all the supported embedded servers.\n\n`restx-server-*` are needed only if you want to be able to run restx as a standalone app rather than deploying it\nIf you want to deploy in a web server, you will ` restx-servlet `\n\n\n### Metrics:\n\n- `restx-monitor-codahale`: Codahale metrics for monitor module. Not compatible with Google App Engine.\n\n\n### Others:\n\n- `restx-samplest`: both a sample of individual features and JUnit tests of them\n- `restx-samplest-kotlin`: Same as `restx-samplest` but for demo-ing restx with kotlin support\n- `restx-annotation-processors-package`: assembly module for annotation processor only, if you prefer to setup annotation processing manually with `-proc` javac option\n- `restx-barbarywatch`: MacOSX filesystem watching that actually works. Only module with GPL license, but no other module depend on it, it's detected at runtime, and used only during development\n\n\n## Publish release\nPour release sur RESTX :\n- Il faut avoir une paire de clé GPG\n  Pour générer sa paire de clé GPG sur Mac OS :\n  brew install gpg\n  gpg --full-gen-key\n  Sélectionner 'RSA et DSA' (choix par défault)\n  Mettre 4096 bits\n  Mettre une expiration de la clé (3 ans c'est bien).\n  Mettre son nom + email\n- Envoyer la clé public sur le serveur de Ubuntu via la commande :\n  gpg --keyserver keyserver.ubuntu.com --send-keys YOUR_KEY_ID\n  Pour trouver l'id de votre clé :\n  gpg --list-keys\n- Avoir configurer son settings.xml dans son .m2\n``\u003csettings\u003e\n  \u003cservers\u003e\n  \u003cserver\u003e\n  \u003cid\u003egpg.passphrase\u003c/id\u003e\n  \u003cpassword\u003ePASSPHRASE CLE GPG SI DEFINI\u003c/password\u003e\n  \u003c/server\u003e\n  \u003cserver\u003e\n  \u003cid\u003eossrh\u003c/id\u003e\n  \u003cusername\u003eLOGIN_COMPTE_SONATYPE\u003c/username\u003e\n  \u003cpassword\u003ePASSWORD_COMPTE_SONATYPE\u003c/password\u003e\n  \u003c/server\u003e\n  \u003cserver\u003e\n  \u003cid\u003esonatype-nexus-snapshots\u003c/id\u003e\n  \u003cusername\u003eLOGIN_COMPTE_SONATYPE\u003c/username\u003e\n  \u003cpassword\u003ePASSWORD_COMPTE_SONATYPE\u003c/password\u003e\n  \u003c/server\u003e\n  \u003cserver\u003e\n  \u003cid\u003esonatype-nexus-release\u003c/id\u003e\n  \u003cusername\u003eLOGIN_COMPTE_SONATYPE\u003c/username\u003e\n  \u003cpassword\u003ePASSWORD_COMPTE_SONATYPE\u003c/password\u003e\n  \u003c/server\u003e\n  \u003cserver\u003e\n  \u003cid\u003esonatype-nexus-staging\u003c/id\u003e\n  \u003cusername\u003eLOGIN_COMPTE_SONATYPE\u003c/username\u003e\n  \u003cpassword\u003ePASSWORD_COMPTE_SONATYPE\u003c/password\u003e\n  \u003c/server\u003e\n  \u003c/servers\u003e\n  \u003c/settings\u003e``\n- Avoir les droits sur Sonatype pour publier la release sur Maven Central (on peut le faire Nicolas ou moi si besoin).\n- type command to release rc2 and prepare a rc3\n``./release.sh 1.0.0-rc2-SNAPSHOT 1.0.0-rc3``\n\n## Contributing\n\nContributions are welcome, fork the repo, push your changes to a branch and send a Pull Request.\n\nTo be sure the PR will be merged please discuss it on the google group before, or create an issue on GitHub to initiate the discussion.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frestx%2Frestx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frestx%2Frestx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frestx%2Frestx/lists"}