Mitchell McKenna - tagged with api http://mitchmckenna.com/feed en-us http://blogs.law.harvard.edu/tech/rss LifePress mitchellmckenna@gmail.com Blueman: Convert API Blueprint to a Postman Collection http://mitchmckenna.com/post/16204/blueman-convert-api-blueprint-to-a-postman-collection

Blue(print)+(post)man - clever! Use Drafter to convert your .apib file into .json, then use Blueman to convert json to a postman collection.json, open postman, import it, voila! Currently needs a little work around until Protagonist is ready to replace Drafter, instructions here.

]]>
Thu, 18 Feb 2016 13:05:00 -0500 http://mitchmckenna.com/post/16204/blueman-convert-api-blueprint-to-a-postman-collection/blueman-convert-api-blueprint-to-a-postman-collection
JSON API — A specification for building APIs in JSON http://mitchmckenna.com/post/15792/json-api-a-specification-for-building-apis-in-json

Building a JSON API, you should be trying to follow the JSON API spec. Save your team the effort of arguing the best response format. It reached version 1.0 earlier this year, so it's safe to say there won't be too many big changes now.

It defines a standard for what the offsets in the json response should include: a resource is returned in "data", pagination in "links", errors in "errors", additional data in "meta", and a standard for including other objects aka "compound documents" in "relationships"/"included", so that instead of embedding other resource objects inside the main resource it flattens the graph of objects to eliminate duplicate data in the response (eg. the same user can be both the post author and a comment author).

If you're curious about some of the design decisions or how it compares to HAL, check out the FAQ.

]]>
Sun, 27 Sep 2015 16:34:00 -0400 http://mitchmckenna.com/post/15792/json-api-a-specification-for-building-apis-in-json/json-api-a-specification-for-building-apis-in-json
Dredd - API Testing Framework http://mitchmckenna.com/post/15790/dredd-api-testing-framework

Dredd is a command-line tool for validating API documentation written in API Blueprint format against its actual code. With Dredd you can easily plug your API documentation into a Continous Integration system like Travis CI or Jenkins and have API documentation up-to-date, all the time. Works to test API's written in PHP, Node.js, Ruby and Python. I've been using Swagger for API docs, but I'm looking forward to trying out Dredd + Blueprint in a future project.

]]>
Sat, 26 Sep 2015 20:59:00 -0400 http://mitchmckenna.com/post/15790/dredd-api-testing-framework/dredd-api-testing-framework
Socialite Providers - 70+ Social Providers for Laravel Socialite http://mitchmckenna.com/post/15508/socialite-providers-70-social-providers-for-laravel-socialite

This allows numerous providers to be used in addition to the ones provided by Laravel Socialite (and they can be overridden easily). You can also easily create your own new providers.

]]>
Mon, 18 May 2015 16:54:00 -0400 http://mitchmckenna.com/post/15508/socialite-providers-70-social-providers-for-laravel-socialite/socialite-providers-70-social-providers-for-laravel-socialite
Flysystem - One Common API to Local or Remote File Storage http://mitchmckenna.com/post/14128/flysystem-one-common-api-to-local-or-remote-file-storage

Flysystem is a filesystem abstraction which allows you to easily swap out a local filesystem for a remote one. Redis and Memcache caching. Emulates directories in systems that support none, like AwsS3. Supports third party plugins. Makes it easy to test your filesystem interactions.

]]>
Sat, 01 Mar 2014 23:45:00 -0500 http://mitchmckenna.com/post/14128/flysystem-one-common-api-to-local-or-remote-file-storage/flysystem-one-common-api-to-local-or-remote-file-storage
RAML - Model a RESTful API http://mitchmckenna.com/post/13522/raml-model-a-restful-api

Before you start coding your API, you should model it out; see what kind of endpoints you're going to need and what kind of parameters they're going to accept. RAML is very colorful visual way of modeling an API.

]]>
Mon, 14 Oct 2013 14:19:00 -0400 http://mitchmckenna.com/post/13522/raml-model-a-restful-api/raml-model-a-restful-api
I/O Docs - API Documentation Generator http://mitchmckenna.com/post/13302/io-docs-api-documentation-generator

I/O Docs is a live interactive documentation system for RESTful web APIs. Open sourced by the talented API guys at Mashery. I/O Docs is a lot like Swagger except I/O Docs isn't just a spec, it's the interpreter as well and it's written in NodeJS.

]]>
Sat, 24 Aug 2013 15:14:00 -0400 http://mitchmckenna.com/post/13302/io-docs-api-documentation-generator/io-docs-api-documentation-generator
Swagger: REST API Documentation Generator http://mitchmckenna.com/post/13301/swagger-rest-api-documentation-generator

Swagger is a popular open source spec to auto-generate very nice looking API documentation with the ability to easily try any API request. You can use the Swagger's own swagger-core framework for node.js, Java or scala, but there's is also support in many other languages because of the strong open source community behind it for other languages like PHP, Ruby, Python, etc. Swagger's biggest open source competitor is Mashery's I/O Docs.

]]>
Sat, 24 Aug 2013 15:04:00 -0400 http://mitchmckenna.com/post/13301/swagger-rest-api-documentation-generator/swagger-rest-api-documentation-generator
Build an API with CodeIgniter http://mitchmckenna.com/post/9544/build-an-api-with-codeigniter

Great video and nettuts article from Phil Sturgeon on how we can use CodeIgniter to create a RESTful API for your existing web applications, and demonstrate how to interact with your own API or other RESTful web-services, such as Facebook and Twitter.

]]>
Wed, 11 May 2011 04:12:00 -0400 http://mitchmckenna.com/post/9544/build-an-api-with-codeigniter/build-an-api-with-codeigniter
Adding Custom Google Maps to Your Website http://mitchmckenna.com/post/8240/adding-custom-google-maps-to-your-website

"Maps are often placed on a company website to help customers find their way there. For that, Google Maps is excellent. But wouldn’t it be nice to add your company logo, parking lots, train stations, etc. to the map, to help the customer even more? It is very simple, and in this article I am going to show you how."

]]>
Sun, 12 Sep 2010 22:55:00 -0400 http://mitchmckenna.com/post/8240/adding-custom-google-maps-to-your-website/adding-custom-google-maps-to-your-website