Markdown is supported in the Swagger Editor. Below is an example of using Markdown in an OpenAPI (Swagger) document:

    swagger: &#39;2.0&#39;
    info:
      version: 0.0.0
      title: Markdown 
      description: |
        # Heading
        
        Text attributes _italic_, *italic*, __bold__, **bold**, `monospace`.
        
        Horizontal rule:
        
        ---
    
        Bullet list:
        
          * apples
          * oranges
          * pears
          
        Numbered list:
        
          1. apples
          2. oranges
          3. pears
          
        A [link](http://example.com).

        An image:
        ![Swagger logo](https://raw.githubusercontent.com/swagger-api/swagger-ui/master/dist/favicon-32x32.png)

        Code block:

        ```
        {
          &quot;message&quot;: &quot;Hello, world!&quot;
        }
        ```

        Tables:
    
        | Column1 | Column2 |
        | ------- | --------|
        | cell1   | cell2   |
    paths:
      /:
        get:
          responses:
            200:
              description: OK

You can copy and paste the above example to the [Swagger Editor][1] to see the output.


  [1]: http://editor.swagger.io/

The angular2 documentation about [Route Guards][1] left me unclear about when it is appropriate to use a `CanActivate` guards vs. a `CanActivateChild` guard in combination with component-less routes. 

**TL;DR:**  what&#39;s the point in having `canActivateChild` when I can use a component-less routes with `canActivate` to achieve the same effect?

Long version: 
&gt; We can have multiple guards at every level of a routing hierarchy. The
&gt; router checks the CanDeactivate and CanActivateChild guards first,
&gt; from deepest child route to the top. Then it checks the CanActivate
&gt; guards from the top down to the deepest child route.

I get that `CanActivateChild` is checked bottom up and `CanActivate` is checked top down. What doesn&#39;t make sense to me is the following example given in the docs: 

    @NgModule({    
      imports: [
        RouterModule.forChild([
          {
            path: &#39;admin&#39;,
            component: AdminComponent,
            canActivate: [AuthGuard],
            children: [
              {
                path: &#39;&#39;,
                canActivateChild: [AuthGuard],
                children: [
                  { path: &#39;crises&#39;, component: ManageCrisesComponent },
                  { path: &#39;heroes&#39;, component: ManageHeroesComponent },
                  { path: &#39;&#39;, component: AdminDashboardComponent }
                ]
              }
            ]
          }
        ])
      ],
      exports: [
        RouterModule
      ]
    })
    export class AdminRoutingModule {}

So the `admin` path has a component-less route: 

&gt; Looking at our child route under the AdminComponent, we have a route
&gt; with a path and a children property but it&#39;s not using a component. We
&gt; haven&#39;t made a mistake in our configuration, because we can use a
&gt; component-less route.

Why is the code in this case inserting the `AuthGuard` in the child and in the root component (path `admin`)? Wouldn&#39;t is suffice to guard at the root? 

I have created a [plunkr][2] based on the sample that removes the `canActivateChild: [AuthGuard]` and adds a logout button on the `AdminDashboard`. Sure enough, the `canActivate` of the parent route still guards, so what&#39;s the point in having `canActivateChild` when I can use component-less routes with `canActivate`?


  [1]: https://angular.io/docs/ts/latest/guide/router.html#!#guards
  [2]: http://plnkr.co/edit/B6s8H17q3pGDp2QAqKIU

CanActivate vs. CanActivateChild with component-less routes

Can you explain me why react show warning `Warning: validateDOMNesting(...): #text cannot appear as a child of &lt;tr&gt;. See Router &gt; RouterContext &gt; CarWashPage &gt; AllCarWashTable &gt; tr &gt; #text.`? I don&#39;t see any text inside tag `tr`

**Code that renders table**

    export default class AllCarWashTable extends React.Component{

    constructor(props) {
        super(props);
        this.generateHeaders = this.generateHeaders.bind(this);
        this.generateRows = this.generateRows.bind(this);
    };

    static propTypes = {
        cols : React.PropTypes.array.isRequired,
        rows : React.PropTypes.array.isRequired
    }

    generateHeaders() {
        let cols = this.props.cols;  // [{key, label}]
        return cols.map(function(colData) {
            return &lt;th key={colData.key}&gt; {colData.label} &lt;/th&gt;;
        });
    }

    generateRows() {
        let cols = this.props.cols,  // [{key, label}]
            data = this.props.rows;
        if (this.props.rows.length &gt; 0) {
            return data.map(function(item) {
                var cells = cols.map(function(colData) {
                    return &lt;td key={colData.key}&gt; {item[colData.key]} &lt;/td&gt;;
                });
                return &lt;tr key={item.id}&gt; {cells} &lt;/tr&gt;;
            });
        }
    }

    render(){
        let headers = this.generateHeaders();
        let rows = this.generateRows();

        return (
             &lt;table className=&quot;table table-hove&quot;&gt;
                 &lt;thead&gt;
                    &lt;tr&gt;
                        {headers}
                    &lt;/tr&gt;
                 &lt;/thead&gt;
                 &lt;tbody&gt;
                        {rows}
                 &lt;/tbody&gt;

             &lt;/table&gt;
        )
    }
    }

At the end, **my table has the following structure** 

[![enter image description here][1]][1]


  [1]: http://i.stack.imgur.com/ebTAe.png


Where is the problem?

React: validateDOMNesting: #text cannot appear as a child of &lt;tr&gt;

I would like to format my Swagger API descriptions so that they are not simple paragraphs of text.  Preferably, I&#39;d like to add a small table to it.

I did not find an online reference about text formatting in Swagger descriptions.  If I launch the [Swagger Editor][1], and open the Instagram example (File \ Open Example \ Instagram.yaml), I see the the first description in the yaml file shows some formatting including a hyperlink and bounding box:

        [registered your client](http://instagram.com/developer/register/) it&#39;s easy
    to start requesting data from Instagram.

    ```
      https://api.instagram.com/v1/media/popular?client_id=CLIENT-ID
    ```

This looks like standard [Markdown][2], but when I add a table markdown to the samples description, the editor presents an error:

    |Col1|Col2|
    |------|------|
    |1|2|

    
    YAML Syntax Error
    End of the stream or a document separator is expected at line 36, column

What formatting does Swagger 2.0 allow?
Am I doing something wrong to render a table?


  [1]: http://editor.swagger.io/#/
  [2]: https://en.wikipedia.org/wiki/Markdown

How to format Swagger 2.0 text descriptions?

I would like to format my Swagger API descriptions so that they are not simple paragraphs of text. Preferably, I'd like to add a small table to it.
I did not find an online reference about text formatting in Swagger descriptions. If I launch the <a href="http://editor.swagger.io/#/" target="_blank" rel="noopener noreferrer">Swagger Editor</a>, and open the Instagram example (File \ Open Example \ Instagram.yaml), I see the the first description in the yaml file shows some formatting including a hyperlink and bounding box:
<pre><code class="hljs language-less"> [registered your client](http://instagram.com/developer/register/) it's easy
to start requesting data from Instagram.

```
 https://api.instagram.com/v1/media/popular?client_id=CLIENT-ID
```
</code></pre>
This looks like standard <a href="https://en.wikipedia.org/wiki/Markdown" target="_blank" rel="noopener noreferrer">Markdown</a>, but when I add a table markdown to the samples description, the editor presents an error:
<pre><code class="hljs language-sql">|Col1|Col2|
|------|------|
|1|2|


YAML Syntax Error
End of the stream or a document separator is expected at line 36, column
</code></pre>
What formatting does Swagger 2.0 allow?
Am I doing something wrong to render a table?

At times, I&#39;ve seen ``.pickle``, ``.pck``, ``.pcl``, and ``.db`` for files that contain Python pickles, but I am unsure what is the most common or best practice. I know that the latter three extensions are also used for other things.

The related question is: What MIME type is preferred for sending pickles between systems using a REST API?


Preferred (or most common) file extension for a Python pickle

All the articles about GraphQL will tell you how wonderful it is, but are there any disadvantages or shortcomings to it? Thank you.

Are there any disadvantages to GraphQL?

I&#39;m a beginner with spring boot. I&#39;m involved in the beginning of a project where we would build rest services using spring boot. Could you please advise the recommended directory structure to follow when building a project that will just expose rest services?

What is the recommended project structure for spring boot rest projects?

In my react app i am using [axios][1] to perform the REST api requests.

But it&#39;s unable to send the *Authorization* header with the request.

Here is my code:

    tokenPayload() {
      let config = {
        headers: {
          &#39;Authorization&#39;: &#39;Bearer &#39; + validToken()
        }
      }
      Axios.post( 
          &#39;http://localhost:8000/api/v1/get_token_payloads&#39;,
          config
        )
        .then( ( response ) =&gt; {
          console.log( response )
        } )
        .catch()
    }

Here the `validToken()` method would simply return the token from browser storage.

All requests are having a 500 error response saying that 

&gt; The token could not be parsed from the request

from the back-end.

How to send the authorization header with each requests? Would you recommend any other module with react?


  [1]: https://github.com/mzabriskie/axios

Sending the bearer token with axios

I want to know the main difference between REST and API. Sometimes I see REST API in programming documents, then is REST or API same as REST API? I would like to know more about relation between REST, API and REST API.



What is difference between REST and API?

I&#39;m writing documents that should explain code in C# using Markdown.

I use the ` ```csharp` to get csharp highlighting.

I sometimes want to highlight something specific in the code using bold or anything.

I know about `&lt;pre&gt;` etc... but it takes away my csharp highlighting.

Best case scenario - some way to highlight code in the ` ```csharp` section.

Next best thing - I can write the code as diff - using + and - to highlight stuff, but how do I tell Github to highlight diff syntax with the red and green backcolor?

Is there a way to use both diff and csharp syntax highlighting?

Diff syntax highlighting in Github Markdown

for some reason no link in my R markdowns (rmd) is formatted blue. knitting the simple rmd below to pdf is leaving the text color black. only when hovering over it does one realize that it&#39;s actually a link. knitting it to html will make the link blue. of course I can use a latex wrapper but I wonder why that is?

&gt; sessionInfo()
R version 3.3.0 (2016-05-03)
Platform: x86_64-w64-mingw32/x64 (64-bit)
Running under: Windows 7 x64 (build 7601) Service Pack 1
loaded via a namespace (and not attached):
 knitr_1.15

RStudio 1.0.44

    ---
    title: &quot;R Notebook&quot;
    output:
      pdf_document: default
      html_notebook: default
    ---

    ```{r, echo=F}
    # tex / pandoc options for pdf creation
    x &lt;- Sys.getenv(&quot;PATH&quot;)
    y &lt;- paste(x, &quot;E:\\miktex\\miktex\\bin&quot;, sep=&quot;;&quot;)
    Sys.setenv(PATH = y)
    ```

    [link](www.rstudio.com)

[![enter image description here][1]][1]
  [1]: https://i.stack.imgur.com/awos7.png

R markdown link is not formatted blue when knitted to pdf

eg:

    ```
    some very long line; some very long line; some very long line; some very long line; some very long line; some very long line; some very long line; some very long line; some very long line; some very long line; 
    ```

will force user to scroll in github/gitlab issues.
Is there a way to soft-line wrap inside ``` code block ``` ?

I&#39;ve read the related questions but they seem different (eg jekyll etc).

EDIT: manually editing code to limit to 80 columns is not a viable option (eg, when pasting from a compiler output/log etc; that&#39;s a lot of work and should not be necessary)

EDIT: see also https://github.com/softvar/enhanced-github/issues/95

How to wrap long lines inside of markdown ``` code ``` in Github and Gitlab issues?

I want to add the image in the Jupyter notebook and I want to have particular height and width. 
When I try to add the image using 

&gt; `![](img.png)`

 
the code is adding the complete image but as per the image dimension and I don&#39;t have control over it.
I try to use **![](img.png =200x100)** but then the image does not appear. 

Does anybody know of a way to add an image with pre-specified dimensions?

Resize the image in jupyter notebook using markdown

Does anyone know how to display a local image in markdown? I don&#39;t want to setup a webserver for that.

I try the following in markdown, but it doesn&#39;t work: 

```![image](files/Users/jzhang/Desktop/Isolated.png)```



How do I display local image in markdown?

How to I define in OpenAPI/Swagger if a field is optional or required and what is the default?

How to specify if a field is optional or required in OpenAPI/Swagger?

I&#39;m using Swashbuckle to generate swagger documentation\UI for a webapi2 project.  Our models are shared with some legacy interfaces so there are a couple of properties I want to ignore on the models.  I can&#39;t use JsonIgnore attribute because the legacy interfaces also need to serialize to JSON so I don&#39;t want to ignore the properties globally, just in the Swashbuckle configuration.

I found a method of doing this documented here:

https://github.com/domaindrivendev/Swashbuckle/issues/73

But this appears to be out of date with the current Swashbuckle release. 

The method recommended for the old version of Swashbuckle is using an IModelFilter implementation as follows:


    public class OmitIgnoredProperties : IModelFilter
    {
        public void Apply(DataType model, DataTypeRegistry dataTypeRegistry, Type type)
        {
            var ignoredProperties = … // use reflection to find any properties on 
                                      // type decorated with the ignore attributes

            foreach (var prop in ignoredProperties) 
                model.Properties.Remove(prop.Name);

        }
    }
    
    SwaggerSpecConfig.Customize(c =&gt; c.ModelFilter&lt;OmitIgnoredProperties&gt;());

But I&#39;m unsure how to configure Swashbuckle to use the IModelFilter in the current version?  I&#39;m using Swashbuckle 5.5.3. 


How to configure Swashbuckle to ignore property on model

I have some endpoints in the API - `/user/login`, `/products`.


In Swagger UI I post `email` and `password` to `/user/login` and as a response I receive a `token` string.

Then, I can copy the token from the response and want to use it as `Authorization` header value in requests to all urls if it&#39;s present, and to `/products` as an example.

Should I create a text input manually somewhere on the Swagger UI page, then put the token there and somehow inject in the requests or are there tools to manage it in a better way?

How to send custom headers with requests in Swagger UI?

I searched for possible ways to add a request header parameter that would be added automatically to every method in my `web-api` but i couldn&#39;t find a clear one. 

While searching i found that the method `OperationFilter()` has to do something about it. 


Web Api How to add a Header parameter for all API in Swagger

This is my understanding:  

 - Swagger is a notation/rules to write documentation. But why is it called a framework (like Angular/MVC)?
 - Swashbuckle is a program (JavaScript?) that generates the documentation (based on Swagger rules).
 - Swagger UI displays the documentation. It uses Swashbuckle to do this.

Is this information correct?  If not can someone explain in simple terms what Swagger, Swashbuckle, and Swashbuckle UI mean? 

Also, what do I lose as an API developer if I do not use this?

What is Swagger, Swashbuckle and Swashbuckle UI

I have added Swagger to my Spring Boot 2 application:

This is my Swagger config:

    @Configuration
    @EnableSwagger2
    public class SwaggerConfig {
    
        @Bean
        public Docket api() {
    	    // @formatter:off
            return new Docket(DocumentationType.SWAGGER_2)  
                    .select()                                  
                    .apis(RequestHandlerSelectors.any())              
                    .paths(PathSelectors.any())                          
                    .build();
            // @formatter:on
        }
    }

This is Maven dependency:

    &lt;!-- Swagger2 --&gt;
    &lt;dependency&gt;
        &lt;groupId&gt;io.springfox&lt;/groupId&gt;
        &lt;artifactId&gt;springfox-swagger2&lt;/artifactId&gt;
        &lt;version&gt;2.8.0&lt;/version&gt;
    &lt;/dependency&gt;
    &lt;dependency&gt;
        &lt;groupId&gt;io.springfox&lt;/groupId&gt;
        &lt;artifactId&gt;springfox-swagger-ui&lt;/artifactId&gt;
        &lt;version&gt;2.8.0&lt;/version&gt;
    &lt;/dependency&gt;

When I try to invoke for example http://localhost:8080/api/actuator/auditevents  it fails with the following error:

    TypeError: Failed to execute &#39;fetch&#39; on &#39;Window&#39;: Request with GET/HEAD method cannot have body.

[![enter image description here][1]][1]

What am I doing wrong and how to fix it ?

  [1]: https://i.stack.imgur.com/4EyaE.png

Swagger TypeError: Failed to execute &#39;fetch&#39; on &#39;Window&#39;: Request with GET/HEAD method cannot have body

I have the following schema definition:

&lt;!-- language: lang-yaml --&gt;

    swagger: &#39;2.0&#39;
    ...
    definitions:
      Service:
        type: object
        properties:
          serviceId:
            type: string
            description: Device or service identification number
            example: 1111111111      
          location:
            type: string
            description: Location of the service
            example: &#39;400 Street name, City State postcode, Country&#39;

I would like to do annotate the `location` field as deprecated. Is there a way to do this?

Content Type	Original Author	Original Content on Stackoverflow
Question	TERACytE	View Question on Stackoverflow
Solution 1 - Rest	Wilson	View Answer on Stackoverflow

How to format Swagger 2.0 text descriptions?

Rest Problem Overview

Rest Solutions

Solution 1 - Rest

React: validateDOMNesting: #text cannot appear as a child of <tr>

CanActivate vs. CanActivateChild with component-less routes

Attributions