How to Implement the File Upload Process in a REST API

September 25 2017

4 comments 0
rest file api upload

This post was written by one of the stars in our developer community, Thiago Santana. 

File-sharing is one of the most elementary ways to perform system integration. In the context of web applications, we call “upload” the process in which a user sends data/files from a local computer to a remote computer.

What is a RESTful API?

When you’re designing an API, it’s important to know the type of API you want for your specific project and what it’s advantages and disadvantages are. REST, or RESTful APIs are some of the most popular APIs; but how do you know that this type of API is right for what you want to do?

RESTful APIs are designed to take advantage of existing protocols.

Json validation using a draft v4 schema? Oh Yeah!

motif

Sometimes you’re expecting a JSON, specially when publishing or consuming a REST API. But you need to make sure it’s a good JSON, not the kind of JSON that would kill you with a machete. Since the Javascript Object Notation format (JSON for short) can be used to described pretty much anything, validating that the one you received actually complies with what you expected is no simple task. Or at least it wasn’t until the JSON schema specification came out.

API Best Practices: Hypermedia (Part 4.2)

December 18 2014

0 comments 0
motif

This is part four, sub-series 2, of the API design best practices series. Jump to sub-series 1 of the hypermedia sub-series.

The Harsh Reality of the State of Hypermedia Specs

Hypermedia sounds great in theory,

API Best Practices: Hypermedia (Part 4.1)

December 11 2014

3 comments 0
motif

This is part four, sub-series 1, of the API design best practices series.

What is Hypermedia

One of the challenges to implementing and correctly using hypermedia in your REST API is first understanding what hypermedia is,

API Best Practices: Nouns, CRUD, and More (Part 3)

December 4 2014

0 comments 0
motif

This is part three of the API design best practices series.

Once you have an understanding of what your API needs to be able to do in order to meet your developer’s requirements, it’s important to ensure that it remains as flexible and extendable as possible.  Taking advantage of best practices not only means that your API will be familiar to developers,

API Best Practices: Plan Your API (Part 1)

November 13 2014

0 comments 0
motif

This is part one of the API design best practices series.

Understand WHY you are building an API

Perhaps the foundation of the foundation, understanding why you are building an API is a crucial step towards understanding what data/ methods your API should make accessible and how your users will utilize it.