Package com.mediumapi.client

Interface SearchApiClient

public interface SearchApiClient
A delegate to be called by the Controller}. Implement this interface with a Service annotated class.

  • Method Summary

    Modifier and Type
    Method
    Description
    default Optional<org.springframework.web.context.request.NativeWebRequest>
    getRequest()
     
    default org.springframework.http.ResponseEntity<MediumSearchArticles>
    searchArticlesGet(String query)
    GET /search/articles : Search Articles Returns the list of `articles_ids` for the given search query results.
    default org.springframework.http.ResponseEntity<MediumSearchLists>
    searchListsGet(String query)
    GET /search/lists : Search Lists Returns an array of `list_ids` for the given search query results.
    default org.springframework.http.ResponseEntity<MediumSearchPublications>
    searchPublicationsGet(String query)
    GET /search/publications : Search Publications Returns the list of `publication_ids` for the given search query results.
    default org.springframework.http.ResponseEntity<MediumSearchTags>
    searchTagsGet(String query)
    GET /search/tags : Search Tags Returns a list of `tags` for the given search query results.
    default org.springframework.http.ResponseEntity<MediumSearchUsers>
    searchUsersGet(String query)
    GET /search/users : Search Users Returns a list of `user_ids` for the given search query results.

  • Method Details

    • getRequest

      default Optional<org.springframework.web.context.request.NativeWebRequest> getRequest()

    • searchArticlesGet

      default org.springframework.http.ResponseEntity<MediumSearchArticles> searchArticlesGet(String query)
      GET /search/articles : Search Articles Returns the list of `articles_ids` for the given search query results. (Max Length = 1000)
      Parameters:
      query - Search query (required)
      Returns:
      OK (status code 200)
      See Also:

    • searchListsGet

      default org.springframework.http.ResponseEntity<MediumSearchLists> searchListsGet(String query)
      GET /search/lists : Search Lists Returns an array of `list_ids` for the given search query results. (Max Length = 1000)
      Parameters:
      query - Search query (required)
      Returns:
      OK (status code 200)
      See Also:

    • searchPublicationsGet

      default org.springframework.http.ResponseEntity<MediumSearchPublications> searchPublicationsGet(String query)
      GET /search/publications : Search Publications Returns the list of `publication_ids` for the given search query results. (Max Length = 1000)
      Parameters:
      query - Search query (required)
      Returns:
      OK (status code 200)
      See Also:

    • searchTagsGet

      default org.springframework.http.ResponseEntity<MediumSearchTags> searchTagsGet(String query)
      GET /search/tags : Search Tags Returns a list of `tags` for the given search query results. (Max Length = 1000)
      Parameters:
      query - Search query (required)
      Returns:
      OK (status code 200)
      See Also:

    • searchUsersGet

      default org.springframework.http.ResponseEntity<MediumSearchUsers> searchUsersGet(String query)
      GET /search/users : Search Users Returns a list of `user_ids` for the given search query results. (Max Length = 1000)
      Parameters:
      query - Search query (required)
      Returns:
      OK (status code 200)
      See Also: