Beefy Boxes and Bandwidth Generously Provided by pair Networks
No such thing as a small change
 
PerlMonks  

Comment on

( #3333=superdoc: print w/ replies, xml ) Need Help??
If I had any recommendation to make for an API it would be: use JSON POSTing over HTTPS. Always.

Please do not use SOAP or any other XML based transport again. Ever.

Please do not use REST. REST ends up being wildly inconsistent and offers nearly no benefit. Do not use PUT or DELETE which are supposed to have obtuse HTTP statuses and truncated response data. And for consistency, don't use GET. Always use POST.

If you need to Create, Read, Update, Delete (CRUD), then simply consistently name your methods (server_add, server_info, server_update, server_delete, user_add, user_info, user_update, user_delete). Attach those on your endpoint (https://$host/$endpoint/server_info) and be done with it.

Consistency is one hallmark of a well designed API.

Update: The JSON bit isn't required - just trendy. Replace with sereal, amqp, storable and whatever the flavor of the decade is (as long as the flavor is not XML). But make sure you justify why you're not using JSON - which is widely more usable from other languages and platforms.

my @a=qw(random brilliant braindead); print $a[rand(@a)];

In reply to Re: modern ways of doing web services by Rhandom
in thread modern ways of doing web services by Anonymous Monk

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post; it's "PerlMonks-approved HTML":



  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • Outside of code tags, you may need to use entities for some characters:
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.
  • Log In?
    Username:
    Password:

    What's my password?
    Create A New User
    Chatterbox?
    and the web crawler heard nothing...

    How do I use this? | Other CB clients
    Other Users?
    Others drinking their drinks and smoking their pipes about the Monastery: (6)
    As of 2014-11-23 11:19 GMT
    Sections?
    Information?
    Find Nodes?
    Leftovers?
      Voting Booth?

      My preferred Perl binaries come from:














      Results (131 votes), past polls