Package com.mediumapi.client

Interface ArticleApiClient

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

  • Method Summary

    Modifier and Type
    Method
    Description
    default org.springframework.http.ResponseEntity<MediumArticleAssets>
    articleArticleIdAssetsGet(String articleId)
    GET /article/{article_id}/assets : Get Article Assets Returns a list of URLs for the assets present in the Medium Article.
    default org.springframework.http.ResponseEntity<MediumArticleContent>
    articleArticleIdContentGet(String articleId)
    GET /article/{article_id}/content : Get Article's Content Returns the content of an article for the given `article_id`.
    default org.springframework.http.ResponseEntity<MediumArticleFans>
    articleArticleIdFansGet(String articleId)
    GET /article/{article_id}/fans : Get Article Fans Returns a list of `user_ids` of the people who clapped on the article (a.k.a `voters`).
    default org.springframework.http.ResponseEntity<MediumArticle>
    articleArticleIdGet(String articleId)
    GET /article/{article_id} : Get Article Info Returns article-related information such as - Title - Subtitle - Author (ID) - Tags - Topics (assigned by Medium) - Publication (ID) - Published date and time - Last Modified date and time - Clap Count - Voter Count - Word Count - Response Count - Reading Time - Language - Unique Slug - URL - Image URL (Cover image) - Top Highlight - Whether the article is in a series or not (boolean) - Whether the article is a shortform or not (boolean) - Whether the article is locked or not (boolean)
    default org.springframework.http.ResponseEntity<MediumArticleHTML>
    articleArticleIdHtmlGet(String articleId, Boolean fullpage, String styleFile)
    GET /article/{article_id}/html : Get Article's HTML Returns the **plain HTML** of a Medium Article, for the given `article_id`.
    default org.springframework.http.ResponseEntity<MediumArticleMarkdown>
    articleArticleIdMarkdownGet(String articleId)
    GET /article/{article_id}/markdown : Get Article's Markdown Returns the markdown of a Medium Article/Story, for the given `article_id`
    default org.springframework.http.ResponseEntity<MediumArticleRecommended>
    articleArticleIdRecommendedGet(String articleId)
    GET /article/{article_id}/recommended : Get Recommended Articles Returns a list of 10 articles (`article_ids`) as recommended by the Medium, for the given article.
    default org.springframework.http.ResponseEntity<MediumArticleRelated>
    articleArticleIdRelatedGet(String articleId)
    GET /article/{article_id}/related : Get Related Articles Returns a list of `article_ids` of the related posts.
    default org.springframework.http.ResponseEntity<MediumArticleResponses>
    articleArticleIdResponsesGet(String articleId)
    GET /article/{article_id}/responses : Get Article Responses Returns a list of responses (`response_ids`, same as `article_ids`) for a given article (`article_id`) **Note:** To see the content of the response, use the _Get Article's Content_ endpoint (`/article/{article_id}/content`)
    default Optional<org.springframework.web.context.request.NativeWebRequest>
    getRequest()
     

  • Method Details

    • getRequest

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

    • articleArticleIdAssetsGet

      default org.springframework.http.ResponseEntity<MediumArticleAssets> articleArticleIdAssetsGet(String articleId)
      GET /article/{article_id}/assets : Get Article Assets Returns a list of URLs for the assets present in the Medium Article. These assets may include images, embedded YouTube videos, Github Gists, Hyperlinks (anchors), Links to other Medium Articles, etc…
      Parameters:
      articleId - It's a unique hash id assigned to every Medium Article. (required)
      Returns:
      OK (status code 200)
      See Also:

    • articleArticleIdContentGet

      default org.springframework.http.ResponseEntity<MediumArticleContent> articleArticleIdContentGet(String articleId)
      GET /article/{article_id}/content : Get Article's Content Returns the content of an article for the given `article_id`.
      Parameters:
      articleId - It's a unique hash id assigned to every Medium Article. (required)
      Returns:
      OK (status code 200)
      See Also:

    • articleArticleIdFansGet

      default org.springframework.http.ResponseEntity<MediumArticleFans> articleArticleIdFansGet(String articleId)
      GET /article/{article_id}/fans : Get Article Fans Returns a list of `user_ids` of the people who clapped on the article (a.k.a `voters`).
      Parameters:
      articleId - It's a unique hash id assigned to every Medium Article. (required)
      Returns:
      OK (status code 200)
      See Also:

    • articleArticleIdGet

      default org.springframework.http.ResponseEntity<MediumArticle> articleArticleIdGet(String articleId)
      GET /article/{article_id} : Get Article Info Returns article-related information such as - Title - Subtitle - Author (ID) - Tags - Topics (assigned by Medium) - Publication (ID) - Published date and time - Last Modified date and time - Clap Count - Voter Count - Word Count - Response Count - Reading Time - Language - Unique Slug - URL - Image URL (Cover image) - Top Highlight - Whether the article is in a series or not (boolean) - Whether the article is a shortform or not (boolean) - Whether the article is locked or not (boolean)
      Parameters:
      articleId - It's a unique hash id assigned to every Medium Article. (required)
      Returns:
      OK (status code 200)
      See Also:

    • articleArticleIdHtmlGet

      default org.springframework.http.ResponseEntity<MediumArticleHTML> articleArticleIdHtmlGet(String articleId, Boolean fullpage, String styleFile)
      GET /article/{article_id}/html : Get Article's HTML Returns the **plain HTML** of a Medium Article, for the given `article_id`. **Note:** This plain HTML output can be stylized as per your own custom branding. For the sample CSS, visit: \"https://mediumapi.com/styles/dark.css\"
      Parameters:
      articleId - It's a unique hash id assigned to every Medium Article. (required)
      fullpage - If 'true', returns full HTML page with head, body, title and meta tags. Else, returns HTML inside body only. (optional)
      styleFile - Name or link to a CSS file to be included in the HTML. It works when `fullpage` is true. (optional)
      Returns:
      OK (status code 200)
      See Also:

    • articleArticleIdMarkdownGet

      default org.springframework.http.ResponseEntity<MediumArticleMarkdown> articleArticleIdMarkdownGet(String articleId)
      GET /article/{article_id}/markdown : Get Article's Markdown Returns the markdown of a Medium Article/Story, for the given `article_id`
      Parameters:
      articleId - It's a unique hash id assigned to every Medium Article. (required)
      Returns:
      OK (status code 200)
      See Also:

    • articleArticleIdRecommendedGet

      default org.springframework.http.ResponseEntity<MediumArticleRecommended> articleArticleIdRecommendedGet(String articleId)
      GET /article/{article_id}/recommended : Get Recommended Articles Returns a list of 10 articles (`article_ids`) as recommended by the Medium, for the given article.
      Parameters:
      articleId - It's a unique hash id assigned to every Medium Article. (required)
      Returns:
      OK (status code 200)
      See Also:

    • articleArticleIdRelatedGet

      default org.springframework.http.ResponseEntity<MediumArticleRelated> articleArticleIdRelatedGet(String articleId)
      GET /article/{article_id}/related : Get Related Articles Returns a list of `article_ids` of the related posts. (Length = 4)
      Parameters:
      articleId - It's a unique hash id assigned to every Medium Article. (required)
      Returns:
      OK (status code 200)
      See Also:

    • articleArticleIdResponsesGet

      default org.springframework.http.ResponseEntity<MediumArticleResponses> articleArticleIdResponsesGet(String articleId)
      GET /article/{article_id}/responses : Get Article Responses Returns a list of responses (`response_ids`, same as `article_ids`) for a given article (`article_id`) **Note:** To see the content of the response, use the _Get Article's Content_ endpoint (`/article/{article_id}/content`)
      Parameters:
      articleId - It's a unique hash id assigned to every Medium Article. (required)
      Returns:
      OK (status code 200)
      See Also: