Package com.mediumapi.apiclient

Interface ArticleApi

public interface ArticleApi

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, @Valid Boolean fullpage, @Valid 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 ArticleApiClient	getDelegate()

Method Details

getDelegate

default ArticleApiClient getDelegate()

articleArticleIdAssetsGet

@RequestMapping(method=GET,
                value="/article/{article_id}/assets",
                produces="application/json")
default org.springframework.http.ResponseEntity<MediumArticleAssets> articleArticleIdAssetsGet(@PathVariable("article_id")
 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)

articleArticleIdContentGet

@RequestMapping(method=GET,
                value="/article/{article_id}/content",
                produces="application/json")
default org.springframework.http.ResponseEntity<MediumArticleContent> articleArticleIdContentGet(@PathVariable("article_id")
 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)

articleArticleIdFansGet

@RequestMapping(method=GET,
                value="/article/{article_id}/fans",
                produces="application/json")
default org.springframework.http.ResponseEntity<MediumArticleFans> articleArticleIdFansGet(@PathVariable("article_id")
 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)

articleArticleIdGet

@RequestMapping(method=GET,
                value="/article/{article_id}",
                produces="application/json")
default org.springframework.http.ResponseEntity<MediumArticle> articleArticleIdGet(@PathVariable("article_id")
 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)

articleArticleIdHtmlGet

@RequestMapping(method=GET,
                value="/article/{article_id}/html",
                produces="application/json")
default org.springframework.http.ResponseEntity<MediumArticleHTML> articleArticleIdHtmlGet(@PathVariable("article_id")
 String articleId,
 @Valid @RequestParam(value="fullpage",required=false)
 @Valid Boolean fullpage,
 @Valid @RequestParam(value="style_file",required=false)
 @Valid 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)

articleArticleIdMarkdownGet

@RequestMapping(method=GET,
                value="/article/{article_id}/markdown",
                produces="application/json")
default org.springframework.http.ResponseEntity<MediumArticleMarkdown> articleArticleIdMarkdownGet(@PathVariable("article_id")
 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)

articleArticleIdRecommendedGet

@RequestMapping(method=GET,
                value="/article/{article_id}/recommended",
                produces="application/json")
default org.springframework.http.ResponseEntity<MediumArticleRecommended> articleArticleIdRecommendedGet(@PathVariable("article_id")
 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)

articleArticleIdRelatedGet

@RequestMapping(method=GET,
                value="/article/{article_id}/related",
                produces="application/json")
default org.springframework.http.ResponseEntity<MediumArticleRelated> articleArticleIdRelatedGet(@PathVariable("article_id")
 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)

articleArticleIdResponsesGet

@RequestMapping(method=GET,
                value="/article/{article_id}/responses",
                produces="application/json")
default org.springframework.http.ResponseEntity<MediumArticleResponses> articleArticleIdResponsesGet(@PathVariable("article_id")
 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)