Skip to content

Commit cb446e8

Browse files
committed
Lint markdown
1 parent e338333 commit cb446e8

File tree

1 file changed

+18
-19
lines changed

1 file changed

+18
-19
lines changed

README.md

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,45 @@
1+
# swagger-node
2+
13
[![Build Status](https://travis-ci.org/swagger-api/swagger-node.svg?branch=master)](https://travis-ci.org/swagger-api/swagger-node)
24
[![NPM version](https://badge.fury.io/js/swagger.png)](http://badge.fury.io/js/swagger)
35
[![Dependency Status](https://david-dm.org/swagger-api/swagger-node/status.svg)](https://david-dm.org/swagger-api/swagger-node)
46
[![devDependency Status](https://david-dm.org/swagger-api/swagger-node/dev-status.svg)](https://david-dm.org/swagger-api/swagger-node#info=devDependencies)
57

6-
78
The `swagger` module provides tools for designing and building Swagger-compliant APIs entirely in Node.js. It integrates with popular Node.js servers, including Express, Hapi, Restify, and Sails, as well as any Connect-based middleware. With `swagger`, you can specify, build, and test your API from the very beginning, on your laptop. It allows you to change and iterate your design without rewriting the logic of your implementation.
89

910
![alt text](./docs/images/overview2.png)
1011

11-
1212
Remember, one great thing about this approach is that all of the Swagger validation logic is handled for you, and all of the routing logic is managed through the Swagger configuration. You don't have to code (or recode!) any of that stuff yourself.
1313

14-
# Your swagger API in five steps
14+
## Your swagger API in five steps
1515

16-
## 1. Install the swagger module
16+
### 1. Install the swagger module
1717

1818
Install using npm. For complete instructions, see the [install](./docs/install.md) page.
1919

2020
```bash
21-
$ npm install -g swagger
21+
npm install -g swagger
2222
```
2323

24-
## 2. Create a new swagger project
24+
### 2. Create a new swagger project
2525

2626
Use the [CLI](./docs/cli.md) to create and manage projects. Learn more on the [quick start](./docs/quick-start.md) page.
2727

2828
```bash
29-
$ swagger project create hello-world
29+
swagger project create hello-world
3030
```
3131

32-
## 3. Design your API in the Swagger Editor
32+
### 3. Design your API in the Swagger Editor
3333

3434
The interactive, browser-based [Swagger Editor](http://editor.swagger.io/) is built in. It provides Swagger 2.0 validation and endpoint routing, generates docs on the fly, and consumes easy-to-read YAML.
3535

3636
```bash
37-
$ swagger project edit
37+
swagger project edit
3838
```
3939

4040
![screenshot of project editor](./docs/images/project-editor.png)
4141

42-
## 4. Write controller code in Node.js
42+
### 4. Write controller code in Node.js
4343

4444
Code your API's business logic in Node.js.
4545

@@ -63,15 +63,15 @@ Controller source code is always placed in `./api/controllers`. So, the controll
6363

6464
The `operationId` element specifies which controller function to call. In this case (line 19), it is a function called `hello`. Learn [more](./docs/controllers.md).
6565

66-
## 5. Run the server
66+
### 5. Run the server
6767

6868
Run the project server.
6969

7070
```bash
71-
$ swagger project start
71+
swagger project start
7272
```
7373

74-
## Now, call the API!
74+
## Now, call the API
7575

7676
It just works!
7777

@@ -80,32 +80,31 @@ $ curl http://127.0.0.1:10010/hello?name=Scott
8080
{ "message": "Hello, Scott!" }
8181
```
8282

83-
# <a name="installation"></a>Installing the swagger module
83+
## <a name="installation"></a>Installing the swagger module
8484

8585
See the [Installing swagger](./docs/install.md) for details.
8686

87-
# <a name="using"></a>Using the swagger module
87+
## <a name="using"></a>Using the swagger module
8888

8989
Go to the [swagger module doc page](./docs/README.md). It includes all the information you need to get started.
9090

91-
# <a name="about"></a>About this project
91+
## <a name="about"></a>About this project
9292

9393
This initiative grew out of Apigee-127, an API design-first development framework using Swagger.
9494
Apigee donated the code to create the swagger-node project in 2015.
9595

9696
>Copyright 2016 Apigee Corporation
97-
9897
>Licensed under the Apache License, Version 2.0 (the "License");
98+
9999
you may not use this file except in compliance with the License.
100100
You may obtain a copy of the License at
101101

102102
>http://www.apache.org/licenses/LICENSE-2.0
103-
104103
>Unless required by applicable law or agreed to in writing, software
104+
105105
distributed under the License is distributed on an "AS IS" BASIS,
106106
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
107107
See the License for the specific language governing permissions and
108108
limitations under the License.
109109

110110
---
111-
<img src="http://swagger.io/wp-content/uploads/2016/02/logo.jpg"/>

0 commit comments

Comments
 (0)