Click here to Skip to main content
15,895,142 members
Please Sign up or sign in to vote.
1.00/5 (3 votes)
See more:
I have this API documentation and am supposed to make into a more user-friendly plugin like a widget.

How do you do that?

Here’s a sample of the code;
POST /message?key=[KEY]&performerId=[id]&customerId=[id]&nickname=[nickname] HTTP/1.1
Host: [API]:80

[message]

Parameters
Name Required Type Description
key Yes string Supplied by VS. Please ask us for your key.
performerId Yes integer The id of the performer in whose room the chat should appear.
customerId No integer The unique id of the customer. If no id is provided, it is assumed that this is an unregistered customer.
nickname Yes string The name that this user will appear as in the chat.
post-data Yes string This is the message that the customer wishes to say to the room (max 200 chars).
Example Response
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: [int]

{
success: true | false
message: [string]
}
Response Parameters
Name Description
success Whether or not your post was successful.
message An error message if success is false.



What I have tried:

I ahve the API documentation for different Requests and Responses however they seem rather slim in the details causing developers to spend a lot of time when integrating. Isn't there a way to take these docs and create a more user friendly plugin or template that a developer could more easily use?
Posted
Updated 9-Aug-17 18:02pm
Comments
Dave Kreskowiak 9-Aug-17 17:22pm    
Generate requirements, plan, and write code? How else do you think this question should be answered?

Unless you're asking something that I'm not seeing...

1 solution

If i am understanding your question correctly, your issue is that you've got API documentation that is hard to read/understand and is lacking in detail but you want to convert it into a more user friendly format that helps developers help themselves?

I would suggest looking at some of these API documentation tools. Some of them may have steep learning curves, but once you get use to them they will make your API's easy to use.

One thing to note about these tools, you can put lipstick on a pig but it is still a pig. Meaning, if you don't provide the content to these API's to make them more clear, your just trading one unclear/not developer friendly API document for another unclear/not developer friendly API document.

Swagger – The World's Most Popular Framework for APIs.[^]

API Blueprint | API Blueprint[^]

GitHub - lord/slate: Beautiful static documentation for your API[^]
 
Share this answer
 

This content, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)



CodeProject, 20 Bay Street, 11th Floor Toronto, Ontario, Canada M5J 2N8 +1 (416) 849-8900