我尝试在编写视图集和使用django rest docs时记录API .我遇到以下问题:
如果我尝试发送反向相关字段的值,它会获取值列表,但是当在Form-data中发送数据时,它会以字符串形式出现.
文档UI中没有文件上传选项.
以下是我的代码:
models.py
class Area(models.Model):
id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
name = models.CharField(max_length=100)
address = models.TextField()
image = models.ImageField(upload_to='area/')
created_on = models.DateTimeField(auto_now_add=True)
modified_on = models.DateTimeField(auto_now=True)
zipcode = models.CharField(max_length=15, null=True)
is_verified = models.BooleanField(default=False)
class Meta:
ordering = ('-modified_on',)
class Email(models.Model):
id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
email = models.EmailField()
area = models.ForeignKey(Area, on_delete=models.CASCADE, null=True, related_name='email')
class Phone(models.Model):
id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
phone = models.CharField(max_length=15)
area = models.ForeignKey(Area, on_delete=models.CASCADE, null=True, related_name='phone')
view.py
class AreaViewSet(viewsets.ModelViewSet):
""" …在Swagger API文档中,在apis数组旁边的json里面有一个模型对象条目,但没有关于它的文档.我该如何使用这个"模型"部分？
{
apiVersion: "0.2",
swaggerVersion: "1.1",
basePath: "http://petstore.swagger.wordnik.com/api",
resourcePath: "/pet.{format}"
...
apis: [...]
models: {...}
}
我正在尝试清理我的python代码文档,并决定使用sphinx-doc,因为它看起来不错.我喜欢如何使用以下标签引用其他类和方法:
:class:`mymodule.MyClass` About my class.
:meth:`mymodule.MyClass.myfunction` And my cool function
我试图弄清楚如何在函数中记录参数名称,所以如果我有一个像这样的函数:
def do_this(parameter1, parameter2):
"""
I can describe do_this.
:something?:`parameter1` And then describe the parameter.
"""
这是最好的做法是什么？
更新:
正确的语法是:
def do_this(parameter1, parameter2):
"""
I can describe do_this.
:something parameter1: And then describe the variable
"""
我创建了一个使用setuptools的演示项目,它具有以下结构:
project/
|- pizza/
| |- __init__.py
| `- margherita.py
|
|- README.rst
|- setup.cfg
`- setup.py
我正在尝试使用Sphinx自动生成此项目的文档.到目前为止,我已经尝试过:
# Generate a sphinx template
sphinx-quickstart
# Use default settings, except for project name, etc.
sphinx-apidoc -o source .
./setup.py build_sphinx
我觉得必须有到自动生成使用本文档更简单的方法README,setup.py和文档字符串.
最后,我想为另一个使用Python C-api的项目自动生成apidocs.我找不到任何东西.
我的主要问题是:是否有更简单的方法来自动生成此文档？
我使用.Net 4.5创建了一个WebAPI,并希望使用Swagger记录此API .我在我的.Net项目中添加了swagger-ui.现在,当我浏览到../swagger-ui/index.html时,它以swagger UI格式成功打开宠物商店api-docs(json).
我的问题是如何为我的WebAPI控制器和模型创建这样的(swagger)json？因为我已经为c#类和属性添加了必需的XML摘要/注释.
我看到Swagger.Net和Swashbuckle在做类似的事情,但我真的不明白如何使用它们中的任何一个生成swagger-json文件.我可能会犯很小的错误,但无法指出.
请帮忙.
有没有办法在模型部分中定义HashMap或Generic Object类型？我有一个返回产品的REST服务,这些产品可以有不同的选项.options属性基本上是一个HashMap,其中id是选项名称,其值是选项值.
当我运行sphinx-apidoc然后make html它产生doc页面时,在目录(TOC)中的每个模块/包名称的末尾都有"Subpackages"和"Submodules"部分以及"module"和"package".如何在不编辑Sphinx源代码的情况下阻止编写这些额外的标题？
这是我想要制作的示例文档页面(注意TOC):
http://selenium.googlecode.com/svn/trunk/docs/api/py/index.html#documentation
据我所知,这是由于sphinx源代码中的apidoc.py文件(第88行):
我可以手动编辑每个单独的.rst文件来删除这些标题,或者只是从脚本中删除那些代码行,但是我必须编译Sphinx源代码.有没有手动编辑Sphinx源的自动方式？
Android API文档在谈论"远程对象"时意味着什么？
例如,IBinder状态的API文档:
此接口描述了与远程对象交互的抽象协议.
但我已经搜索过,似乎无法找到任何定义,例如"远程对象是一个对象......等等......等等......"
我们基于Azure功能构建了API，并且所有API都是基于Python的。我知道 APIM 提供了一种导入 Azure 函数以及创建和管理 API 的好方法。然而，我正在为开发人员寻找一种轻便快速的解决方案，以便他们可以相互合作。
Swagger 在 Java 生态系统中非常流行，我们只需添加一些注释即可在 Spring Boot 应用程序中使用。
对于用 Python 编写的 Azure 函数，是否有类似的功能可用。我的最终目标是通过某些端点公开 API 文档，以便不同的团队（API 生产者和消费者）可以高效工作，而无需经过融合等