tfredrich / restapitutorial.com Goto Github PK

HTML Source code for www.RestApiTutorial.com

Home Page: http://www.RestApiTutorial.com

License: Creative Commons Attribution Share Alike 4.0 International

HTML 100.00%

restapitutorial.com's Introduction

HTML source code for www.RestApiTutorial.com.

Also includes the PDF, ePub and Mobi (Kindle) versions of the associated RESTful Best Practices document. In addition, the Libre/Open Office version of the source document is included in the 'media' directory.

This work by RestApiTutorial.com is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

restapitutorial.com's People

Contributors

Stargazers

Watchers

Forkers

repos-api jalalhejazi zlumber opawtech lmheah flolagale vinnyj95 wordpressdev alliadt asturn flyingbeyond bgarlock numbata pg1337 willwotechnologies ankurtrapasiya tamish1 cjwfly1988 whoget maggiezhou codemedic awaked carlolee chocofede jeffkarbel hamedmp janeski-zz rodrigues882013 break123 kgundula stephenanthony jordan-carl hassansalehe jesman kylefoo junchaohu laptite derikitz alexkimani mwasyou lifthz soufatn gideon-maina nejmbe mittuvaz viniciussalmeida sucer yadol kennbalobalo steadyd matdonkey skv-headless liyocee ettysekhon abhiskaushik blackumbrella sadleb siso mykook jortsc andreicalistru 10na leloyo vpalacka williamli domdere dianadujing kishore-123 joeromero hobokenmartha nikoms tirumalarakesh dlnufox cazacugmihai arr-dev lostsakya fmarcos83 mkleine allenyang0308 cybernetics purepennons nnanna217 joesimonsen guslora alexswider ouroboros77 giovanni1986 bdacode solarsbangle xiaojichao ritukapoor leecade deannariddlespur liang90925 arulbalans smitzter bambiedjj dfparker2002 benzliu zhongming2013

restapitutorial.com's Issues

Create a portuguese version and use i18n

This doc is amazing, it deserves a portuguese doc! Right?

Is there someone here to accept a pull request that I'll do?

Create a i18n implementation
Translate all text files
Use some popular framework to do it

This is my proposal.

Switch bootstrap CDN

My corporate firewall blocks https://d7im4lln3lvbg.cloudfront.net. Can you switch to another CDN, such as https://www.bootstrapcdn.com/ ?

Thank you for your consideration.

405 has different descriptions

The 405 is discussed in two places: httpstatuscodes and restquicktips. It would be better to refer to one description or use the same (partial) text. It's a bit confusing with two different descriptions.

1 Some limitations of pluralization

Hey

I've found at least two limitations in the pluralization of nouns in web services:

When the singular form and the plural form are the same (for example "species"), there is no mean of indicating whether the resource is a singleton
When a program or a human being only knows the singular forms of your entities, the plural forms must be found or guessed. The guessing isn't trivial to implement (I partially did it). Think about "watch -> whatches", "entity -> entities", "index -> indices or indexes", "status -> statuses", "appendix -> appendices", ...

Singularization wouldn't help. Moreover, using a plural form or a singular form doesn't tell you whether your collections allow duplicate elements. That's why I prefer using this kind of perfectible solution:
GET http://www.example.com/customerSet/33245/orderSet/8769/lineitemSet/1

Note that the second limitation can harm when designing automatic test procedures to ensure that all web services work except if the plural forms are used everywhere in your code, both in your database tables and in your classes. Would you really create a class named "Customers with an object oriented programming language?

Non responsive web pages

I found that there are some pages those are not responsive for phone or small devices.
Screenshots are attached:

Another:

I have fixed them so can it be merged?

Link to .mobi version results in 404

On page http://www.restapitutorial.com/resources.html there is a link to https://github.com/tfredrich/RestApiTutorial.com/raw/master/media/RESTful_Best_Practices_v1_2.mobi, which is unaccessible.

How is this website created from start?

Is this web site automatically generated or is it manually crafted? what template engines is used etc. I want to create a website like this but I don't want to create everything from scratch.

Other HTTP Verbs

All too often, GET, POST, PUT, and DELETE are the only verbs discussed. Might it be worth adding some of the others, such as HEAD, OPTIONS, and PATCH?

Conflicting text

In the quicktips you describe status 405 as an example for POST. In the HTTP methods 405 is not described as possible return status for a POST.

2 Localization

Any there any plans to translate web-site into other languages?

REST API Tutorial

The Quick-tips page is broken

Links and the Menu-links to this page:
http://www.restapitutorial.com/lessons/restquicktips.html

Where you get a message that it has been moved, to itself...

PUT description states it's not used for create new resource

Contradicting information in one of the page, not sure if it's the right place to post this.

Mozilla source :
https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PUT#example

Your site
https://www.restapitutorial.com/lessons/httpmethods.html#:~:text=The%20primary%20or%20most%2Dcommonly,or%20CRUD)%20operations%2C%20respectively.

Please need confirmation if you can.

I checked multiple site and got contradicting answers.

Thanks

Section has wrong information

In:
RestApiTutorial.com / lessons / idempotency.html

Lines 78-82 are duplicates of 68-71, and don't describe Safety.

Httpmethods page has error in initial load

When opening the httpmethods page, the "more detailed" discussion shows the GET, but the POST header is selected.

Reference OData in the Resources page?

Hi,

I wonder if it'd be useful for RestApiTutorial.com visitors to reference OData related information in its Resource page.

OData is the short for the Open Data Protocol. It's a open industry standard approved by OASIS (ref: https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=odata). It provides specifications and guidelines about how to build and consume REST APIs (URL conventions, behavioral specifications, schema exposure, control information exposure, etc.).

It represents industry practices as Microsoft, SAP, Salesforce, IBM and etc. are all adopting OData as their REST API guidelines.

For more info about it you may refer to http://www.odata.org/.

Consider including industry practise of REST in the RestApiTutorial.com

Hi,

First of all, I want to say that RestApiTutorial.com is really cool, it expresses the REST API principles in a very clear way and I have learned a lot of REST from it. And I think the site will be even better if some industry practice of REST be included (sometimes is still hard for developers to directly design a REST API only following the principles)

I'd like to recommend adding OData to the website. Below are basic information of OData.

OData -- full name Open Data Protocol is open protocol to allow the creation and consumption of queryable and interoperable RESTful APIs in a simple and standard way.
OData is an OASIS standard that defines the best practice for building and consuming RESTful APIs. And the OData community is working on making OData an ISO standard. OData has been applied in many IT industry leaders including Microsoft, SAP, IBM and more in the OData ecosystem.
OData has detailed and continuing improving specifications that covers almost everything in REST principles.
Based on the OData protocol, there are various libraries on different platforms supporting building OData service and consuming OData services, see more at http://www.odata.org/libraries .

I definitely DON'T mean to make your site to become another an odata.org site. But I think adding a link in the RestApiTutorial.com or even a separate page with introduction to OData can help developers easily pick up a good and verified practice of REST and start their work directly (since OData has a lot of existing libraries).

Please help
Gaurav