:sparkles: markdown and readme api

[bpetetot]

60

[bpetetot]

New APIs :

• GET /api/readme : retrieve current README.md file content of the component (if exists)
• POST /api/readme : create / save the README.md file of the component with given content
• POST /api/markdown: generate the markdown from given component docgen

The goal of these APIs is to have the following process (in a next PR) :

1. The user will click on a button documentation
2. It calls GET /api/readme
   • if README.md already exists => display existing markdown in a markdown editor
   • else call POST /api/markdown => put generated markdown in a markdown editor
3. The user can update the component documentation through the editor
   • a save button will call POST /api/readme and save / create the README.md file

I would like also to have buttons in the markdown editor to add some generated parts (in a next PR) :

• Add description : will add the description where the cursor is in the editor
• Add props: will add the component props documentation where the cursor is in the editor
• Add screenshot : will add a component screenshot where the cursor is in the editor

To make the Add description and Add props buttons, I will need to improve API POST /api/markdown adding some query parameters : POST /api/markdown?q=props

[fabienjuif]

I asking myself about endpoints names. Why don't we use:

• /api/file (to replace /api/makrdown), and make it more generic
  • POST /api/file/readme.md by example
• GET /api/documentation to generate the documentation,
  • GET /API/documentation?format=markdown|text|html

The endpoints don't have to be about format but about their purpose don't you think ?

[bpetetot]

Good idea ! We can also merge /api/file with the current /api/fs Examples :

• GET /api/fs/foo/bar will list folder /foo/bar
• GET /api/fs/foo/bar/README.md will get README.md file content
• POST /api/fs/foo/bar/README.md will create / update README.md file
• ...

And I'm agree about being agnostic about the format with API documentation

[fabienjuif]

Yeah I agree about merging both endpoints

[bpetetot]

@fabienjuif you can check it