Start building modern documentation site in 4 steps - Docuo

Documentation - Docuo

Introduction

Basic features

Overview

Quickstart

Set up your first project

Development

Configuration

Getting started

Sidebar

Multi-instance

Versioning

Internationalization

Managing docs

Components

Markdown Editor

VS Code extension

Editing docs

Customize with json file

Customize through platform

Custom domain

Customizing

Make an update

Activity history

Project settings

Updating website

Account settings

Workspace settings

Account management

Search

Analytics

Engaging users

Setup OpenAPI

Writing OpenAPI

Advanced Features

Add a new pet to the store

Create user

Creates list of users with given input array

Creates list of users with given input list

Delete purchase order by ID

Delete user

Deletes a pet

Find pet by ID

Find purchase order by ID

Finds Pets by status

Finds Pets by tags

Get user by user name

Logs out current logged in user session

Logs user into the system

New pet

Place an order for a pet

Returns pet inventories by status

Subscribe to the Store events

Update an existing pet

Updated user

Updates a pet in the store with form data

uploads an image

OpenAPI Demo

Using OpenAPI


<h1 className={"openapi__heading"}>Logs user into the system</h1>

<MethodEndpoint method={"get"} path={"/user/login"}></MethodEndpoint>



## Request
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"username","in":"query","description":"The user name for login","required":true,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"password","in":"query","description":"The password for login in clear text","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details>
<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>successful operation</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul className={"response-headers-container"}><li className={"schemaItem"}><summary style={{}}><strong>X-Rate-Limit</strong><span className={"header-name-type"}> integer</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>calls per hour allowed by the user</div></div></li><li className={"schemaItem"}><summary style={{}}><strong>X-Expires-After</strong><span className={"header-name-type"}> string</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>date in UTC when token expires</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><ul className={"response-schema-first-body-node-container"}><div className={"schema-common-description"}>string</div></ul></details></TabItem><TabItem label={"response"} value={"response"}><ResponseSamples responseExample={"OK"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem><TabItem label={"application/xml"} value={"application/xml"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><ul className={"response-schema-first-body-node-container"}><div className={"schema-common-description"}>string</div></ul></details></TabItem><TabItem label={"response"} value={"response"}><ResponseSamples responseExample={"<Message> OK </Message>"} language={"xml"}></ResponseSamples></TabItem></SchemaTabs></TabItem><TabItem label={"text/plain"} value={"text/plain"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><ul className={"response-schema-first-body-node-container"}>any</ul></details></TabItem><TabItem label={"response"} value={"response"}><ResponseSamples responseExample={"OK"} language={"shell"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>Invalid username/password supplied</div><div></div></TabItem></ApiTabs></div></div>
      

Request

Logs user into the system

https://petstore.swagger.io/v2/user/login

Request

Query Parameters

Responses

Logs user into the system

https://petstore.swagger.io/v2/user/login

Request

Query Parameters

Responses​

Responses