README
¶
naraku (奈落)
"Naraku" is a repository created to assess the quality of End-to-End (E2E) tests using go-spectest/spectest. Spectest is an E2E testing framework, and to confirm its ease of use, it is essential to create test cases for APIs.
I chose to build APIs to test a wide range of API types. If a useful API is created, it will be deployed using Lambda + API Gateway.
API Reference
Please see the API Reference.
/v1/health
curl -X GET "http://localhost:8080/v1/health" -H "accept: application/json" | jq .
{
"name": "naraku",
"version": "unknown",
"revision": "unknown"
}
License
This project is licensed under the MIT License - see the LICENSE file for details.
The origin of the name
The name "Naraku" was borrowed from a character in the series InuYaSha. Naraku is a being formed by the accumulation of numerous demons around a human. The inspiration for the name comes from the way multiple APIs gather in the spectest framework. Naraku is a half-demon with excellent defensive abilities. I also hope that these characteristics will manifest in spectest.
Moreover, "Naraku" also means falling into hell. Don't you think creating and testing numerous APIs can be challenging?
Documentation
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package api control naraku api.
|
Package api control naraku api. |
|
app
|
|
|
domain/model
Package model contains the definitions of domain models and business logic.
|
Package model contains the definitions of domain models and business logic. |
|
domain/service
Package service is an abstraction layer for accessing external services.
|
Package service is an abstraction layer for accessing external services. |
|
external
Package external is the implementation for accessing external services.
|
Package external is the implementation for accessing external services. |
|
infrastructure/persistence/mysql
Package mysql provides a MySQL database.
|
Package mysql provides a MySQL database. |
|
infrastructure/persistence/mysql/mock
Package mock is a package for mocking MySQL.
|
Package mock is a package for mocking MySQL. |
|
Package cmd is a package that contains subcommands for the naraku CLI command.
|
Package cmd is a package that contains subcommands for the naraku CLI command. |
|
Package config load settings from external files or environment variables and manage their values.
|
Package config load settings from external files or environment variables and manage their values. |
|
Package docs Code generated by swaggo/swag.
|
Package docs Code generated by swaggo/swag. |
|
Package version manage naraku version
|
Package version manage naraku version |