jakeworrell / docodile Goto Github PK
View Code? Open in Web Editor NEWGenerate HTML API documentation from a Postman collection
License: MIT License
Generate HTML API documentation from a Postman collection
License: MIT License
Do you plan to add request headers ?
Headers are shown like this in the collection's requests:
"header": [
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept-Language",
"value": "fr",
"disabled": true
},
{
"key": "Authorization",
"value": "Bearer {{admin_token}}"
}
]
Thanks for this project. I see that now markdown support is not correct, right?
Firstly, this is a pretty good project for me, saving lots of time specify API. ๐
Since Chinese will be used sometimes in China, so any plan to support it? Thanks !
root@postman:~/docodile# git diff
diff --git a/templates/index.html b/templates/index.html
index c5ed4c3..86e9392 100644
--- a/templates/index.html
+++ b/templates/index.html
@@ -2,6 +2,7 @@
<html>
<head>
<title>{{request.name}} - {{meta.projectName}}</title>
+ <meta charset="utf-8">
<link rel="stylesheet" type="text/css" href="bootstrap-theme.css">
<link rel="stylesheet" type="text/css" href="styles.css">
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script>
diff --git a/templates/request.html b/templates/request.html
index 9eeddd4..7377d39 100644
--- a/templates/request.html
+++ b/templates/request.html
@@ -2,6 +2,7 @@
<html>
<head>
<title>{{request.name}} - {{meta.projectName}}</title>
+ <meta charset="utf-8">
<link rel="stylesheet" type="text/css" href="../bootstrap-theme.css">
<link rel="stylesheet" href="../highlight/styles/{{meta.highlightTheme}}.css">
<link rel="stylesheet" type="text/css" href="../styles.css">```
No APIs generated for v2.0/2.1 of JSON output in Postman 7.0.9. Just a header title. Reproduce by creating a collection with one request with one parameter.
Thanks for the awesome project.
I have an issue with generating nested items for displaying APIs under subdirectories.
Following is the nested item format.
"item": [
{
"name": "UserAPI",
"description": "User related APIs",
"item": [
{
"name": "Profile",
"description": "Profile related APIs",
"item": [
{
"name": "editProfile.php",
"request": {
"method": "POST",
"header": [],
"body": { ... }
}
},
{ ... }
]
},
{ ... }
]
},
{ ... }
]
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.