Create RESTful search API in Go

[magicoder10]

Please support async and request cancellation based on the examples provided in the comment.
#238

[magicoder10]

Here are some references on goroutine:

1. https://talks.golang.org/2012/concurrency.slide#1
2. https://blog.golang.org/context
3. https://blog.golang.org/pipelines

[lucifercr07]

@byliuyang will like to take it up

[lucifercr07]

Api: /api/search
Header: Auth token
Query params:

1. Paging: query params page.size = 10, page.number = 1 (static for now)
2. type: private or public

[magicoder10]

@lucifercr07 For now, we can hard code page.size. Let open an issue to track custom page size feature. Please document the API endpoint with Swagger ( OpenAPI 3 ). Let's also open an new issue to configure Dredd, a language-agnostic command-line tool for validating API description document against backend implementation of the API.

[magicoder10]

Let's scope this feature down to easy development progress:

1. Create repository interfaces in usecase/repo package. Those interfaces are purely responsible for database access and have nothing to do with search. Create search functionalities (are dependent on usecase/repo interfaces) in usercase/search package.
2. Create RESTful API placeholders in adapter/routing package
3. Call search use cases in the RESTful API.

Hope this helps.

[luisfmelo]

Is this being developed?

[lucifercr07]

@luisfmelo yes

[magicoder10]

Hi @luisfmelo are there any other issue you are interested?

[magicoder10]

For now, please only search private alias

[dawntomm]

I will work on it

[magicoder10]

https://github.com/short-d/short/tree/search

[magicoder10]

Maybe also consider how to build our own Elasticsearch.

[magicoder10]

https://www.elastic.co/elasticsearch/

[magicoder10]

https://www.educative.io/courses/grokking-the-system-design-interview/xV9mMjj74gE

[arberiii]

During my research I found those articles useful:

• The above link mention (Designing Twitter Search)
• https://www.elastic.co/blog/found-elasticsearch-from-the-bottom-up
• https://www.elastic.co/blog/found-sizing-elasticsearch
• https://www.elastic.co/blog/found-elasticsearch-top-down

[magicoder10]

Discussed offline. Due to the complexity of the search engine, let's simplify and focus on implement concurrent search for users and urls for now.

[magicoder10]

To be done now

1. Build the simple search API for user to search their short links

Future Plan

2. Extend the search API to support searching both short link & users concurrently
3. Extract out search into a generic cloud service.