Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hossain-khan/medium-api-specification

API spec for medium.com using OpenAPI Specification (aka Swagger 2.0). Generates PHP, Java, Python, Go, Android, Objective-C and many more client SDK.
https://github.com/hossain-khan/medium-api-specification

client-sdk medium medium-api openapi-specification swagger swagger-specification

Last synced: 4 months ago
JSON representation

API spec for medium.com using OpenAPI Specification (aka Swagger 2.0). Generates PHP, Java, Python, Go, Android, Objective-C and many more client SDK.

Host: GitHub
URL: https://github.com/hossain-khan/medium-api-specification
Owner: hossain-khan
License: mit
Created: 2016-06-26T15:34:56.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2021-08-12T15:05:01.000Z (over 3 years ago)
Last Synced: 2024-10-31T07:51:33.713Z (4 months ago)
Topics: client-sdk, medium, medium-api, openapi-specification, swagger, swagger-specification
Language: Shell
Homepage:
Size: 1.23 MB
Stars: 18
Watchers: 2
Forks: 2
Open Issues: 4
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        * ~UPDATE #1 - Medium.com API is no longer supported.~

* UPDATE #2 - The API is live again, users are allowed to create their own token.

------

> ~Looks like Medium does not support API access anymore. The post with API info has been taken down~ - https://blog.medium.com/welcome-to-the-medium-api-3418f956552 _(Unlisted)_

------

[![https://img.shields.io/badge/OpenAPI-valid-brightgreen.svg](https://img.shields.io/badge/OpenAPI-valid-brightgreen.svg)](http://online.swagger.io/validator?url=https://raw.githubusercontent.com/amardeshbd/medium-api-specification/master/medium-api-specification.yaml) [![Build Status](https://travis-ci.org/amardeshbd/medium-api-specification.svg)](https://travis-ci.org/amardeshbd/medium-api-specification)

Medium.com API Specification

================================

This is an unofficial API specification translated from official API documentation found at [https://github.com/Medium/medium-api-docs](https://github.com/Medium/medium-api-docs) using OpenAPI Specification _(fka [Swagger](http://swagger.io/) 2.0)_.

Why OpenAPI?

------------------

OpenAPI specification is an open standard, it provides variety of support for generating both server and client code for different languages and frameworks. See [Swagger Tools](http://swagger.io/tools/) for more information.

Preview/Test API

--------------------

Best way to preview or test API is using **Swagger UI**, **Swagger Editor** or **Postman**. 

> NOTE: You should generate **self-issued-access-tokens** by following instruction on [official-guide](https://github.com/Medium/medium-api-docs#22-self-issued-access-tokens) to access API endpoints.

 * `Swagger UI` **(Recommended)** - Good for preview API doc. You can [download](https://github.com/swagger-api/swagger-ui) Swagger UI distribution, or open their **[demo](http://petstore.swagger.io/)** site and load the specification URI ([https://raw.githubusercontent.com/amardeshbd/medium-api-specification/master/medium-api-specification.yaml](https://raw.githubusercontent.com/amardeshbd/medium-api-specification/master/medium-api-specification.yaml))

 * `ReDoc` **(Mobile Device Friendly)** - ReDoc is another API spec viewer built by [Rebilly](https://github.com/Rebilly/ReDoc). **[Preview Medium API](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/amardeshbd/medium-api-specification/master/medium-api-specification.yaml)** in Redoc. _(Supports responsive design for both desktop and mobile devices)_

 * `Swagger Editor` - Good for preview, live editor support and API client library code generation support. Open their **[swagger editor](http://editor.swagger.io/)** and load the URL specification above.

 * `Postman` - Good for preview and testing API endpoints. More info at [https://www.getpostman.com/](https://www.getpostman.com/)

### Generating Client SDK

The [swagger-codegen](https://github.com/swagger-api/swagger-codegen) tool can generate client-sdk for different languages. 

Based on [code generator](https://generator.swagger.io) service, following languages are [supported](https://generator.swagger.io/api/gen/clients) by the client generator.

> "akka-scala", "android", "async-scala", "clojure", "cpprest", "csharp", "CsharpDotNet2", "cwiki", "dart", "dynamic-html", "flash", "go", "groovy", "html", "html2", "java", "javascript", "javascript-closure-angular", "jmeter", "objc", "perl", "php", "python", "qt5cpp", "ruby", "scala", "swagger", "swagger-yaml", "swift", "tizen", "typescript-angular", "typescript-angular2", "typescript-fetch", "typescript-node"

Here are few examples: 

 * Android _(with java based retrofit client library)_: [medium-api-android-sample](https://github.com/amardeshbd/medium-api-android-sample)

 * Android _(with java based retrofit+RxJava client library)_ : [android-daily-headlines](https://github.com/amardeshbd/android-daily-headlines) - Uses [NYTimes](https://developer.nytimes.com/) _Top Stories V2_ swagger spec to generate [client library](https://github.com/amardeshbd/android-daily-headlines/tree/develop/api-lib/src/main/java/io/swagger/client).

### Screenshots

 * Swagger UI ![Swagger UI](https://github.com/amardeshbd/medium-api-specification/blob/master/resources/screenshot_openapi_swagger-ui.png)

 * Swagger Editor _(NOTE: Code generation option available here)_ ![Swagger Editor](https://github.com/amardeshbd/medium-api-specification/blob/master/resources/screenshot_openapi_swagger-editor.png)

 * Postman ![Postman](https://github.com/amardeshbd/medium-api-specification/blob/master/resources/screenshot_openapi_postman.png)