thibaud-lclr/api-client
1
0
Fork 0
Code Packages Activity Actions

✨ Introducing API Documentation

Browse source
This commit is contained in:
Liyas Thomas 2019-12-23 08:16:45 +05:30
parent c3a6cc133f
commit 2b40db285e
4 changed files with 32 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -171,6 +171,13 @@ _Official Postwoman Proxy is hosted by ApolloTV - **[Privacy policy](https://apo
_Requests with Pre-Request Scripts are indicated in History entries_
📄 **API Documentation**: Create and share dynamic API documentation easily, quickly.
**Use-cases:**
1. Add your requests to Collections and Folders
2. Export Collections and easily share your APIs with the rest of your team
3. Import Collections and Generate Documentation on-the-go
⌨️ **Keyboard Shortcuts**: Optimized for efficiency.
**Shortcuts:**

5
assets/css/styles.scss
View file

@ -382,6 +382,11 @@ h3.title {
margin: 4px;
}
.info {
margin-left: 4px;
color: var(--fg-light-color);
}
button {
display: inline-flex;
align-items: center;

21
pages/doc.vue
View file

@ -1,6 +1,13 @@
<template>
<div class="page">
<pw-section class="blue" label="Collections" ref="collections">
<ul class="info">
<li>
<p>
Import any Postwoman Collection to Generate Documentation on-the-go.
</p>
</li>
</ul>
<ul>
<li>
<label for="collectionUpload">
@ -76,6 +83,11 @@
<i class="material-icons">insert_drive_file</i>
{{ request.name || "None" }}
</h4>
<p class="doc-desc">
<span>
URL: <code>{{ request.url || "None" }}</code>
</span>
</p>
<p class="doc-desc">
<span>
Path: <code>{{ request.path || "None" }}</code>
@ -94,7 +106,7 @@
</p>
<p class="doc-desc">
<span>
Uername: <code>{{ request.httpUser || "None" }}</code>
Username: <code>{{ request.httpUser || "None" }}</code>
</span>
</p>
<p class="doc-desc">
@ -160,6 +172,11 @@
<i class="material-icons">insert_drive_file</i>
{{ request.name || "None" }}
</h4>
<p class="doc-desc">
<span>
URL: <code>{{ request.url || "None" }}</code>
</span>
</p>
<p class="doc-desc">
<span>
Path: <code>{{ request.path || "None" }}</code>
@ -178,7 +195,7 @@
</p>
<p class="doc-desc">
<span>
Uername: <code>{{ request.httpUser || "None" }}</code>
Username: <code>{{ request.httpUser || "None" }}</code>
</span>
</p>
<p class="doc-desc">

7
pages/settings.vue
View file

@ -134,12 +134,7 @@
</div>
</template>
<style scoped lang="scss">
.info {
margin-left: 4px;
color: var(--fg-light-color);
}
</style>
<style scoped lang="scss"></style>
<script>
export default {