README
¶
URL Shortener
Owner
API
gRPC
The API can be seen in proto files (*.proto) in directory proto/.
RESTful JSON
The API is automatically generated in OpenAPIv2 format when generating gRPC codes.
The generated files are stored in directory openapiv2 in JSON format (*.json).
To see the RESTful API contract, do the following:
- Open the generated json file(s)
- Copy the content
- Open https://editor.swagger.io/
- Paste the content in https://editor.swagger.io/
How to Run
- Read Prerequisites
- Then, read How to Run
Development Guide
- Read Prerequisites
- Then, read Development Guide
Code Map
- Read Code Map
FAQs
- Read FAQs
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
Package entity defines all structs that flowing through all application layers.
|
Package entity defines all structs that flowing through all application layers. |
|
internal
|
|
|
builder
Package builder provides functionality to build the representative flows.
|
Package builder provides functionality to build the representative flows. |
|
config
Package config provides the functionality of managing configuration.
|
Package config provides the functionality of managing configuration. |
|
http2/grpc/handler
Package handler provides the functionality of HTTP/2 gRPC gateway.
|
Package handler provides the functionality of HTTP/2 gRPC gateway. |
|
http2/grpc/server
Package server provides HTTP/2 gRCP server functionality.
|
Package server provides HTTP/2 gRCP server functionality. |
|
repository
Package repository provides real implementation of storing data.
|
Package repository provides real implementation of storing data. |
|
repository/cache
Package cache provides real connection to the cache.
|
Package cache provides real connection to the cache. |
|
repository/database
Package database provides real connection to the database.
|
Package database provides real connection to the database. |
|
tool
Package tool provides tool functionalities.
|
Package tool provides tool functionalities. |
|
proto
|
|
|
indrasaputra/shortener/v1
Package shortenerv1 is a reverse proxy.
|
Package shortenerv1 is a reverse proxy. |
|
test
|
|
|
mock/http2/grpc
Package mock_grpc is a generated GoMock package.
|
Package mock_grpc is a generated GoMock package. |
|
mock/repository
Package mock_repository is a generated GoMock package.
|
Package mock_repository is a generated GoMock package. |
|
mock/usecase
Package mock_usecase is a generated GoMock package.
|
Package mock_usecase is a generated GoMock package. |
|
Package usecase defines the business logic of the requirement.
|
Package usecase defines the business logic of the requirement. |
Click to show internal directories.
Click to hide internal directories.