https://github.com/yagoluiz/user-api
User search API using Golang
https://github.com/yagoluiz/user-api
docker docker-compose fulltext-search golang mongodb
Last synced: 3 months ago
JSON representation
User search API using Golang
- Host: GitHub
- URL: https://github.com/yagoluiz/user-api
- Owner: yagoluiz
- Created: 2021-08-31T13:34:38.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-06-18T14:07:21.000Z (about 3 years ago)
- Last Synced: 2025-01-16T03:14:41.733Z (over 1 year ago)
- Topics: docker, docker-compose, fulltext-search, golang, mongodb
- Language: Go
- Homepage:
- Size: 741 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# User Search API
API responsible for search users using MongoDB [Text Search](https://docs.mongodb.com/manual/text-search).
Branch project implemented in C# => [user-api/dotnet](https://github.com/yagoluiz/user-api/tree/dotnet)
## Instructions for run project
Run project via Docker (using Makefile) or Visual Studio Code (tasks project).
### Docker
```bash
make compose-up
```
```bash
make compose-down
```
```bash
make compose-log-user-api
```
```bash
make compose-log-user-db
```
### VS Code
Execute F5 command and run database:
```bash
make mongo-db
```
## Instructions for run test project
```bash
make test-install-mocks
```
```bash
make test-generate-mocks
```
```bash
make test-run
```
```bash
make test-coverage
```
## Other commands
```bash
make pkg-update
```
## Endpoints
*Swagger*
```bash
http://localhost:8080/swagger/index.html
```
*v1/users/search*
```bash
curl -X 'GET' \
'http://localhost:8080/api/v1/users/search?query=yago&from=1&size=10' \
-H 'accept: application/json'
```