Swagger: Instant, Interactive API Docs

Hey Monoranjan,

Oh, haha, it's a tircky Google Chrome plugin that highlights JSON reponses :) It's called JSONView, you can install this extension for *your* browser and your JSON responses will look exactly like Ryan's ;) Btw, we mentioned this earlier in this course, or in previous courses, but I agree, it's easy to miss :) But now you know! Happy coding with nice JSON highlights now ;)

Cheers!

thank you very much for your answer. now it's working successfully

Hey Thijs-jan V.,

Wow this looks like a BIG project, I'm not sure about how many entities can process default swagger connection, but there is a way to totally customise how it works. Probably it a little complex but it can be a good way. You can read about swagger here https://api-platform.com/do... I like the section about "Overriding the OpenAPI Specification"

PS BTW another tip is to use totally custom swagger it's not too difficult, but very cool to play =)

Cheers!

Hey Ecludio,

Check the Kernel::configureRoutes() in your src/Kernel.php. That method imports all the routes into the system, that import() call allows you to set a prefix via 2nd argument, by default it's "/". I believe that's exactly what you need :)

Cheers!

Hey Saul,

Hm, difficult to say, it looks like you missed something important from the tutorial. Did you download the course code and started from the start/ directory? Or are you following this course on your own project? Please, also, double-check the namespaces of the annotation you're using in your entities, probably you forgot the namespace or used incorrect one. I'd recommend you literally expand all the lines in the code block for the entity you're interested in and copy/paste it into your project. Does it help? Or you still don't see anything? Btw, are you in dev Symfony mode? Please, also try to clear the cache just in case! Does it help?

I really hope this helps!

Cheers!

Hey Gets,

Do you run the project via "symfony serve" command? If so, try "symfony serve --no-tls", or probably better "symfony serve --allow-http" to allow both HTTP and HTTPS connections.

I hope this helps!

Cheers!

Hey @isTom

Does it only appear on your docs or it's also a field of your API endpoints?

They only appear on /api/docs. API responses look ok.

Hey, sorry for my late response. If the API endpoints are ok, then I believe you added that extra information to your docs through any of the methods shown in this page https://api-platform.com/do...

Hello Diego,
I cannot identify any additional information in my class and sure there is nothing named <b>additionalProp1</b>
`
/**

• ContentProviders
  *
• @ORM\Table(name="content_providers",
• indexes={
• @ORM\Index(name="title", columns={"title"}),
• },
• uniqueConstraints={@ORM\UniqueConstraint(columns={"identification"})}
• )
• @UniqueEntity(fields={"identification"}, message="app.unique_value_required")
• @ApiResource(
• collectionOperations={"get", "post"},
• itemOperations={
• "get"={},
• "put"
• },
• shortName="content_providers",
• normalizationContext={"groups"={"content_providers:read"}, "swagger_definition_name"="Read"},
• denormalizationContext={"groups"={"content_providers:write"}, "swagger_definition_name"="Write"},
• )
• @ORM\Entity
  */

class ContentProviders
{

/**
 * @var int
 *
 * @ORM\Column(name="id", type="integer", nullable=false, options={"unsigned"=true})
 * @ORM\Id
 * @ORM\GeneratedValue(strategy="IDENTITY")
 * @Groups({"content_providers:read"})
 */
private $id;

/**
 * ContentProviders in the VodSource.
 *
 * @var VodSource
 *
 * @ORM\OneToMany(targetEntity="App\Entity\Main\VodSource", mappedBy="contentProvider")
 * @Groups({"content_providers:read"})
 **/
protected $vodSource;

/**
 * ContentProviders in the VodCreated.
 *
 * @var VodCreated
 *
 * @ORM\OneToMany(targetEntity="App\Entity\Main\VodCreated", mappedBy="contentProvider")
 **/
protected $vodCreated;

/**
 * @var string|null
 *
 * @ORM\Column(name="title", type="string")
 * @Groups({"content_providers:read", "content_providers:write"})
 * @Assert\NotBlank()
 */
private $title;

/**
 * @var string|null
 *
 * @ORM\Column(name="identification", type="string")
 * @Groups({"content_providers:read", "content_providers:write"})
 * @Assert\NotBlank()
 */
private $identification;

/**
 * @var \DateTime|null
 *
 * @ORM\Column(name="created_at", type="datetime", columnDefinition="TIMESTAMP DEFAULT CURRENT_TIMESTAMP")
 * @Groups({"content_providers:read"})
 */
private $createdAt;

/**
 * @var \DateTime|null
 *
 * @ORM\Column(name="updated_at", type="datetime", columnDefinition="TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP")
 * @Groups({"content_providers:read"})
 */
private $updatedAt;

`

Ha! That's weird. What if you commit everything and then execute git grep additionalProp1 so you can track down where it's coming from

Cheers!

Hey @Mike!

Hmm, I've never tried it! It looks like it's a 2 step process:

1) You disable it in JavaScript (since Swagger is a Js library) https://api-platform.com/do...

2) How do you get custom JS onto the page? By overriding/extending the template that renders Swagger: https://api-platform.com/do...

Let me know if it works!

Cheers!

Hey Kasper Smithsonian

I believe you got confused by the file name. This api_platform.yaml files should live inside config/routes not inside config/packages

Cheers!

Hey ddlzz

I haven't done what you are asking but I think you can do it by following this part of the documentation: https://api-platform.com/do...

I hope it helps. Cheers!