REST API Documentation Platform
.everyoneloves__top-leaderboard:empty,.everyoneloves__mid-leaderboard:empty,.everyoneloves__bot-mid-leaderboard:empty{ height:90px;width:728px;box-sizing:border-box;
}
My team and I have been writing some REST APIs and we would like to create some high quality, polished API documentation for our potential clients. I am looking for some sort of platform that could support the following:
- Allows for background / surrounding information about the API
- Allows for use cases / user stories to describe the logical progression of calls to the API in different scenarios
- Allows for images or videos to be embedded for examples and demonstrations.
- Supports Open API 2.0 or 3.0 for the technical documentation
- Allows styling customization for branding purposes
We have been creating and maintaining Swagger 2.0 documentation for our APIs so we already have that covered. We have been using Swagger UI internally for our front end developers to go against. This has been great for the technical documentation, but I feel like Swagger does not support a lot of the background, user story documentation that I would also like to include (maybe I just don't know the spec well enough).
I have looked into some other API documentation platforms which are based off the Swagger / Open API specs. The issue I am finding is that a lot of them are based entirely on spec. This means that all the introduction / user story descriptions are shoved into "info" or "description" fields in markdown. Which I guess does the trick but it feels a bit hackish to me.
Preferably, I would be able to import the technical aspects of the documentation from my Swagger file and manage any additional content through the platform. Any suggestions would be greatly appreciated.
rest swagger documentation
asked Jan 4 at 15:48
decaldecal
3072730
add a comment |
My team and I have been writing some REST APIs and we would like to create some high quality, polished API documentation for our potential clients. I am looking for some sort of platform that could support the following:
- Allows for background / surrounding information about the API
- Allows for use cases / user stories to describe the logical progression of calls to the API in different scenarios
- Allows for images or videos to be embedded for examples and demonstrations.
- Supports Open API 2.0 or 3.0 for the technical documentation
- Allows styling customization for branding purposes
We have been creating and maintaining Swagger 2.0 documentation for our APIs so we already have that covered. We have been using Swagger UI internally for our front end developers to go against. This has been great for the technical documentation, but I feel like Swagger does not support a lot of the background, user story documentation that I would also like to include (maybe I just don't know the spec well enough).
I have looked into some other API documentation platforms which are based off the Swagger / Open API specs. The issue I am finding is that a lot of them are based entirely on spec. This means that all the introduction / user story descriptions are shoved into "info" or "description" fields in markdown. Which I guess does the trick but it feels a bit hackish to me.
Preferably, I would be able to import the technical aspects of the documentation from my Swagger file and manage any additional content through the platform. Any suggestions would be greatly appreciated.
rest swagger documentation
asked Jan 4 at 15:48
decaldecal
3072730
add a comment |
My team and I have been writing some REST APIs and we would like to create some high quality, polished API documentation for our potential clients. I am looking for some sort of platform that could support the following:
- Allows for background / surrounding information about the API
- Allows for use cases / user stories to describe the logical progression of calls to the API in different scenarios
- Allows for images or videos to be embedded for examples and demonstrations.
- Supports Open API 2.0 or 3.0 for the technical documentation
- Allows styling customization for branding purposes
We have been creating and maintaining Swagger 2.0 documentation for our APIs so we already have that covered. We have been using Swagger UI internally for our front end developers to go against. This has been great for the technical documentation, but I feel like Swagger does not support a lot of the background, user story documentation that I would also like to include (maybe I just don't know the spec well enough).
I have looked into some other API documentation platforms which are based off the Swagger / Open API specs. The issue I am finding is that a lot of them are based entirely on spec. This means that all the introduction / user story descriptions are shoved into "info" or "description" fields in markdown. Which I guess does the trick but it feels a bit hackish to me.
Preferably, I would be able to import the technical aspects of the documentation from my Swagger file and manage any additional content through the platform. Any suggestions would be greatly appreciated.
rest swagger documentation
asked Jan 4 at 15:48
decaldecal
3072730
My team and I have been writing some REST APIs and we would like to create some high quality, polished API documentation for our potential clients. I am looking for some sort of platform that could support the following:
- Allows for background / surrounding information about the API
- Allows for use cases / user stories to describe the logical progression of calls to the API in different scenarios
- Allows for images or videos to be embedded for examples and demonstrations.
- Supports Open API 2.0 or 3.0 for the technical documentation
- Allows styling customization for branding purposes
We have been creating and maintaining Swagger 2.0 documentation for our APIs so we already have that covered. We have been using Swagger UI internally for our front end developers to go against. This has been great for the technical documentation, but I feel like Swagger does not support a lot of the background, user story documentation that I would also like to include (maybe I just don't know the spec well enough).
I have looked into some other API documentation platforms which are based off the Swagger / Open API specs. The issue I am finding is that a lot of them are based entirely on spec. This means that all the introduction / user story descriptions are shoved into "info" or "description" fields in markdown. Which I guess does the trick but it feels a bit hackish to me.
Preferably, I would be able to import the technical aspects of the documentation from my Swagger file and manage any additional content through the platform. Any suggestions would be greatly appreciated.
rest swagger documentation
rest swagger documentation
asked Jan 4 at 15:48
decaldecal
3072730
asked Jan 4 at 15:48
decaldecal
3072730
asked Jan 4 at 15:48
decaldecal
3072730
asked Jan 4 at 15:48
decaldecal
3072730
asked Jan 4 at 15:48
decaldecal
3072730
3072730
add a comment |
add a comment |
0
active
oldest
votes
Your Answer
StackExchange.ifUsing("editor", function () {
StackExchange.using("externalEditor", function () {
StackExchange.using("snippets", function () {
StackExchange.snippets.init();
});
});
}, "code-snippets");
StackExchange.ready(function() {
var channelOptions = {
tags: "".split(" "),
id: "1"
};
initTagRenderer("".split(" "), "".split(" "), channelOptions);
StackExchange.using("externalEditor", function() {
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled) {
StackExchange.using("snippets", function() {
createEditor();
});
}
else {
createEditor();
}
});
function createEditor() {
StackExchange.prepareEditor({
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: true,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: 10,
bindNavPrevention: true,
postfix: "",
imageUploader: {
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
},
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
});
}
});
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f54042142%2frest-api-documentation-platform%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
0
active
oldest
votes
0
active
oldest
votes
active
oldest
votes
active
oldest
votes
Thanks for contributing an answer to Stack Overflow!
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
To learn more, see our tips on writing great answers.
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f54042142%2frest-api-documentation-platform%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
