Coder Social home page Coder Social logo

jakeworrell / docodile Goto Github PK

View Code? Open in Web Editor NEW
69.0 7.0 22.0 458 KB

Generate HTML API documentation from a Postman collection

License: MIT License

PHP 48.44% HTML 40.72% CSS 8.09% Dockerfile 2.75%
php postman-collection html api-documentation documentation api rest

docodile's People

Contributors

drusy avatar jakeworrell avatar kelvinye avatar malteriesch avatar uddmorningsun avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

docodile's Issues

Display request header

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}}"
    }
]

Markdown support

Thanks for this project. I see that now markdown support is not correct, right?

Support Chinese display use HTML

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">```

Nested items aren't able to be generated

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": { ... }
					}
				},
				{ ... }
				]
		},
		{ ... }
	]
},
{ ... }
]

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.