{"id":24805406,"url":"https://github.com/viadee/apiunit","last_synced_at":"2025-07-14T19:46:05.508Z","repository":{"id":196979164,"uuid":"690452618","full_name":"viadee/apiunit","owner":"viadee","description":"A unit test framework for testing API design guidelines in code-first spring projects.","archived":false,"fork":false,"pushed_at":"2023-09-29T12:35:24.000Z","size":41,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-03-25T08:11:53.223Z","etag":null,"topics":[],"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/viadee.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,"governance":null}},"created_at":"2023-09-12T08:17:05.000Z","updated_at":"2023-09-29T15:04:52.000Z","dependencies_parsed_at":null,"dependency_job_id":"915d726d-2b6a-4d74-aa6a-a2ab1964b206","html_url":"https://github.com/viadee/apiunit","commit_stats":null,"previous_names":["viadee/apiunit"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/viadee/apiunit","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/viadee%2Fapiunit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/viadee%2Fapiunit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/viadee%2Fapiunit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/viadee%2Fapiunit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/viadee","download_url":"https://codeload.github.com/viadee/apiunit/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/viadee%2Fapiunit/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265336649,"owners_count":23749200,"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-01-30T07:18:15.267Z","updated_at":"2025-07-14T19:46:05.451Z","avatar_url":"https://github.com/viadee.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ApiUnit\n\nApiUnit is a free and simple library for checking REST API guidelines of your Java code.\nIt is based on [ArchUnit](https://www.archunit.org/) and uses whose deliverd Java code structure.\nApiUnit's focus is to automatically check compliance with guidelines in projects that are developed with Spring. The analysis takes into account common Spring annotations.\n\n## An Example\n\n### Add the Maven Central dependency to your project\n\n##### Maven\n\n```\n\u003cdependency\u003e\n    \u003cgroupId\u003ede.viadee\u003c/groupId\u003e\n    \u003cartifactId\u003eapiunit\u003c/artifactId\u003e\n    \u003cversion\u003e0.1.0\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n### Create a test\n\n#### Check a couple of Guidelines/Rules\n\n```java\nimport de.viadee.apiunit.ApiUnitTest;\nimport de.viadee.apiunit.ApiUnitTestResultObject;\nimport de.viadee.apiunit.rules.EnumerationValuesMustBeCapitalizedNamesWithUnderscores;\nimport de.viadee.apiunit.rules.HttpGetMethodsMustNotHaveRequestBody;\nimport de.viadee.apiunit.rules.HttpPatchMethodsMustHaveRequestBody;\nimport org.junit.jupiter.api.Test;\n\nimport static org.junit.jupiter.api.Assertions.assertEquals;\n\npublic class MyApiGuidelineTest {\n\n    @Test\n    public void checkApiTests() {\n        ApiUnitTest myTest = new ApiUnitTest(\"de.viadee.project\");\n        myTest.addRule(new EnumerationValuesMustBeCapitalizedNamesWithUnderscores());\n        myTest.addRule(new HttpGetMethodsMustNotHaveRequestBody());\n        myTest.addRule(new HttpPatchMethodsMustHaveRequestBody());\n        myTest.addRule(...);\n        ApiUnitTestResultObject testResult = myTest.check();\n        System.out.println(testResult);\n        assertEquals(0, testResult.getViolationCounter());\n    }\n}\n```\n\nCurrently, the following rules are available for consideration:\n- HttpPutMethodsMustHaveRequestBody\n- HttpPostMethodsMustHaveRequestBody\n- HttpPatchMethodsMustHaveRequestBody\n- HttpGetMethodsMustNotHaveRequestBody\n- HttpDeleteMethodsMustNotHaveRequestBody\n- EnumerationValuesMustBeCapitalizedNamesWithUnderscores\n- EnumerationTypesMustBeUpperCamelCase\n- CollectionIdsMustMatchExpression\n- CollectionIdsMustBeValidCIdentifier\n\nThese rules are based on Google´s [API design guide](https://cloud.google.com/apis/design).\n\n#### Check a single of Guideline/Rule\n\n```java\nimport de.viadee.apiunit.ApiUnitTestResultObject;\nimport de.viadee.apiunit.rules.CollectionIdsMustBeValidCIdentifier;\nimport org.junit.jupiter.api.Test;\n\nimport static org.junit.jupiter.api.Assertions.assertEquals;\n\npublic class MyApiGuidelineTest {\n\n    @Test\n    public void collectionIds_Must_Be_Valid_C_Identifier() {\n        ApiUnitTestResultObject testResult = new CollectionIdsMustBeValidCIdentifier().check(\"de.viadee.project\");\n        assertEquals(0, testResult.getViolationCounter());\n    }\n}\n```\n\n## License\n\nApiUnit is published under the Apache License 2.0, see http://www.apache.org/licenses/LICENSE-2.0 for details.\n\nIt redistributes some third party libraries:\n\n* ArchUnit (https://www.archunit.org/), under Apache License 2.0\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fviadee%2Fapiunit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fviadee%2Fapiunit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fviadee%2Fapiunit/lists"}